/* * Copyright (c) Contributors, http://opensimulator.org/ * See CONTRIBUTORS.TXT for a full list of copyright holders. * * 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 above 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. * * Neither the name of the OpenSimulator Project nor the * names of its contributors may be used to endorse or promote products * derived from this software without specific prior written permission. * * THIS SOFTWARE IS PROVIDED BY THE DEVELOPERS ``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 THE CONTRIBUTORS 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; using OpenSim.Region.ScriptEngine.Interfaces; using key = OpenSim.Region.ScriptEngine.Shared.LSL_Types.LSLString; using rotation = OpenSim.Region.ScriptEngine.Shared.LSL_Types.Quaternion; using vector = OpenSim.Region.ScriptEngine.Shared.LSL_Types.Vector3; using LSL_List = OpenSim.Region.ScriptEngine.Shared.LSL_Types.list; using LSL_String = OpenSim.Region.ScriptEngine.Shared.LSL_Types.LSLString; using LSL_Integer = OpenSim.Region.ScriptEngine.Shared.LSL_Types.LSLInteger; using LSL_Float = OpenSim.Region.ScriptEngine.Shared.LSL_Types.LSLFloat; using LSL_Key = OpenSim.Region.ScriptEngine.Shared.LSL_Types.LSLString; namespace OpenSim.Region.ScriptEngine.Shared.Api.Interfaces { /// /// To permit region owners to enable the extended scripting functionality /// of OSSL, without allowing malicious scripts to access potentially /// troublesome functions, each OSSL function is assigned a threat level, /// and access to the functions is granted or denied based on a default /// threshold set in OpenSim.ini (which can be overridden for individual /// functions on a case-by-case basis) /// public enum ThreatLevel { NoAccess = -1, /// /// Function is no threat at all. It doesn't constitute a threat to /// either users or the system and has no known side effects. /// None = 0, /// /// Abuse of this command can cause a nuisance to the region operator, /// such as log message spew. /// Nuisance = 1, /// /// Extreme levels of abuse of this function can cause impaired /// functioning of the region, or very gullible users can be tricked /// into experiencing harmless effects. /// VeryLow = 2, /// /// Intentional abuse can cause crashes or malfunction under certain /// circumstances, which can be easily rectified; or certain users can /// be tricked into certain situations in an avoidable manner. /// Low = 3, /// /// Intentional abuse can cause denial of service and crashes with /// potential of data or state loss; or trusting users can be tricked /// into embarrassing or uncomfortable situations. /// Moderate = 4, /// /// Casual abuse can cause impaired functionality or temporary denial /// of service conditions. Intentional abuse can easily cause crashes /// with potential data loss, or can be used to trick experienced and /// cautious users into unwanted situations, or changes global data /// permanently and without undo ability. /// High = 5, /// /// Even normal use may, depending on the number of instances, or /// frequency of use, result in severe service impairment or crash /// with loss of data, or can be used to cause unwanted or harmful /// effects on users without giving the user a means to avoid it. /// VeryHigh = 6, /// /// Even casual use is a danger to region stability, or function allows /// console or OS command execution, or function allows taking money /// without consent, or allows deletion or modification of user data, /// or allows the compromise of sensitive data by design. /// Severe = 7 }; public interface IOSSL_Api { void CheckThreatLevel(ThreatLevel level, string function); //OpenSim functions string osSetDynamicTextureURL(string dynamicID, string contentType, string url, string extraParams, int timer); string osSetDynamicTextureURLBlend(string dynamicID, string contentType, string url, string extraParams, int timer, int alpha); string osSetDynamicTextureURLBlendFace(string dynamicID, string contentType, string url, string extraParams, bool blend, int disp, int timer, int alpha, int face); string osSetDynamicTextureData(string dynamicID, string contentType, string data, string extraParams, int timer); string osSetDynamicTextureDataFace(string dynamicID, string contentType, string data, string extraParams, int timer, int face); string osSetDynamicTextureDataBlend(string dynamicID, string contentType, string data, string extraParams, int timer, int alpha); string osSetDynamicTextureDataBlendFace(string dynamicID, string contentType, string data, string extraParams, bool blend, int disp, int timer, int alpha, int face); LSL_Float osGetTerrainHeight(int x, int y); LSL_Float osTerrainGetHeight(int x, int y); // Deprecated LSL_Integer osSetTerrainHeight(int x, int y, double val); LSL_Integer osTerrainSetHeight(int x, int y, double val); //Deprecated //ApiDesc Send terrain to all agents void osTerrainFlush(); int osRegionRestart(double seconds); int osRegionRestart(double seconds, string msg); void osRegionNotice(string msg); void osRegionNotice(LSL_Key agentID, string msg); bool osConsoleCommand(string Command); void osSetParcelMediaURL(string url); void osSetPrimFloatOnWater(int floatYN); void osSetParcelSIPAddress(string SIPAddress); // Avatar Info Commands LSL_List osGetAgents(); string osGetAgentIP(string agent); // Teleport commands void osTeleportAgent(string agent, string regionName, LSL_Types.Vector3 position, LSL_Types.Vector3 lookat); void osTeleportAgent(string agent, int regionX, int regionY, LSL_Types.Vector3 position, LSL_Types.Vector3 lookat); void osTeleportAgent(string agent, LSL_Types.Vector3 position, LSL_Types.Vector3 lookat); void osTeleportOwner(string regionName, LSL_Types.Vector3 position, LSL_Types.Vector3 lookat); void osTeleportOwner(int regionX, int regionY, LSL_Types.Vector3 position, LSL_Types.Vector3 lookat); void osTeleportOwner(LSL_Types.Vector3 position, LSL_Types.Vector3 lookat); // Animation commands void osAvatarPlayAnimation(LSL_Key avatarId, string animation); void osAvatarStopAnimation(LSL_Key avatarId, string animation); #region Attachment commands /// /// Attach the object containing this script to the avatar that owns it without asking for PERMISSION_ATTACH /// /// The attachment point. For example, ATTACH_CHEST void osForceAttachToAvatar(int attachment); /// /// Attach an inventory item in the object containing this script to the avatar that owns it without asking for PERMISSION_ATTACH /// /// /// Nothing happens if the owner is not in the region. /// /// Tha name of the item. If this is not found then a warning is said to the owner /// The attachment point. For example, ATTACH_CHEST void osForceAttachToAvatarFromInventory(string itemName, int attachment); /// /// Attach an inventory item in the object containing this script to any avatar in the region without asking for PERMISSION_ATTACH /// /// /// Nothing happens if the avatar is not in the region. /// /// The UUID of the avatar to which to attach. Nothing happens if this is not a UUID /// The name of the item. If this is not found then a warning is said to the owner /// The attachment point. For example, ATTACH_CHEST void osForceAttachToOtherAvatarFromInventory(string rawAvatarId, string itemName, int attachmentPoint); /// /// Detach the object containing this script from the avatar it is attached to without checking for PERMISSION_ATTACH /// /// Nothing happens if the object is not attached. void osForceDetachFromAvatar(); /// /// Returns a strided list of the specified attachment points and the number of attachments on those points. /// /// avatar UUID /// list of ATTACH_* constants /// LSL_List osGetNumberOfAttachments(LSL_Key avatar, LSL_List attachmentPoints); /// /// Sends a specified message to the specified avatar's attachments on /// the specified attachment points. /// /// /// Behaves as osMessageObject(), without the sending script needing to know the attachment keys in advance. /// /// avatar UUID /// message string /// list of ATTACH_* constants, or -1 for all attachments. If -1 is specified and OS_ATTACH_MSG_INVERT_POINTS is present in flags, no action is taken. /// flags further constraining the attachments to deliver the message to. void osMessageAttachments(LSL_Key avatar, string message, LSL_List attachmentPoints, int flags); #endregion //texture draw functions string osMovePen(string drawList, int x, int y); string osDrawLine(string drawList, int startX, int startY, int endX, int endY); string osDrawLine(string drawList, int endX, int endY); string osDrawText(string drawList, string text); string osDrawEllipse(string drawList, int width, int height); string osDrawFilledEllipse(string drawList, int width, int height); string osDrawRectangle(string drawList, int width, int height); string osDrawFilledRectangle(string drawList, int width, int height); string osDrawPolygon(string drawList, LSL_List x, LSL_List y); string osDrawFilledPolygon(string drawList, LSL_List x, LSL_List y); string osDrawResetTransform(string drawList); string osDrawRotationTransform(string drawList, LSL_Float x); string osDrawScaleTransform(string drawList, LSL_Float x, LSL_Float y); string osDrawTranslationTransform(string drawList, LSL_Float x, LSL_Float y); string osSetFontName(string drawList, string fontName); string osSetFontSize(string drawList, int fontSize); string osSetPenSize(string drawList, int penSize); string osSetPenColor(string drawList, string color); string osSetPenColour(string drawList, string colour); // Deprecated string osSetPenCap(string drawList, string direction, string type); string osDrawImage(string drawList, int width, int height, string imageUrl); vector osGetDrawStringSize(string contentType, string text, string fontName, int fontSize); void osSetStateEvents(int events); void osSetRegionWaterHeight(double height); void osSetRegionSunSettings(bool useEstateSun, bool sunFixed, double sunHour); void osSetEstateSunSettings(bool sunFixed, double sunHour); double osGetCurrentSunHour(); double osGetSunParam(string param); double osSunGetParam(string param); // Deprecated void osSetSunParam(string param, double value); void osSunSetParam(string param, double value); // Deprecated // Wind Module Functions string osWindActiveModelPluginName(); void osSetWindParam(string plugin, string param, LSL_Float value); LSL_Float osGetWindParam(string plugin, string param); // Parcel commands void osParcelJoin(vector pos1, vector pos2); void osParcelSubdivide(vector pos1, vector pos2); void osSetParcelDetails(vector pos, LSL_List rules); void osParcelSetDetails(vector pos, LSL_List rules); // Deprecated string osGetScriptEngineName(); string osGetSimulatorVersion(); LSL_Integer osCheckODE(); string osGetPhysicsEngineType(); string osGetPhysicsEngineName(); void osMessageObject(key objectUUID,string message); void osMakeNotecard(string notecardName, LSL_Types.list contents); string osGetNotecardLine(string name, int line); string osGetNotecard(string name); int osGetNumberOfNotecardLines(string name); string osAvatarName2Key(string firstname, string lastname); string osKey2Name(string id); // Grid Info Functions string osGetGridNick(); string osGetGridName(); string osGetGridLoginURI(); string osGetGridHomeURI(); string osGetGridGatekeeperURI(); string osGetGridCustom(string key); string osGetAvatarHomeURI(string uuid); LSL_String osFormatString(string str, LSL_List strings); LSL_List osMatchString(string src, string pattern, int start); LSL_String osReplaceString(string src, string pattern, string replace, int count, int start); // Information about data loaded into the region string osLoadedCreationDate(); string osLoadedCreationTime(); string osLoadedCreationID(); LSL_List osGetLinkPrimitiveParams(int linknumber, LSL_List rules); /// /// Identical to llCreateLink() but does not require permission from the owner. /// /// /// void osForceCreateLink(string target, int parent); /// /// Identical to llBreakLink() but does not require permission from the owner. /// /// void osForceBreakLink(int linknum); /// /// Identical to llBreakAllLinks() but does not require permission from the owner. /// void osForceBreakAllLinks(); /// /// Similar to llDie but given an object UUID /// /// void osDie(LSL_Key objectUUID); /// /// Check if the given key is an npc /// /// /// TRUE if the key belongs to an npc in the scene. FALSE otherwise. LSL_Integer osIsNpc(LSL_Key npc); key osNpcCreate(string user, string name, vector position, string notecard); key osNpcCreate(string user, string name, vector position, string notecard, int options); LSL_Key osNpcSaveAppearance(key npc, string notecard); void osNpcLoadAppearance(key npc, string notecard); vector osNpcGetPos(key npc); void osNpcMoveTo(key npc, vector position); void osNpcMoveToTarget(key npc, vector target, int options); /// /// Get the owner of the NPC /// /// /// /// The owner of the NPC for an owned NPC. The NPC's agent id for an unowned NPC. UUID.Zero if the key is not an npc. /// LSL_Key osNpcGetOwner(key npc); rotation osNpcGetRot(key npc); void osNpcSetRot(LSL_Key npc, rotation rot); void osNpcStopMoveToTarget(LSL_Key npc); void osNpcSetProfileAbout(LSL_Key npc, string about); void osNpcSetProfileImage(LSL_Key npc, string image); void osNpcSay(key npc, string message); void osNpcSay(key npc, int channel, string message); void osNpcSayTo(LSL_Key npc, LSL_Key target, int channel, string msg); void osNpcShout(key npc, int channel, string message); void osNpcSit(key npc, key target, int options); void osNpcStand(LSL_Key npc); void osNpcRemove(key npc); void osNpcPlayAnimation(LSL_Key npc, string animation); void osNpcStopAnimation(LSL_Key npc, string animation); void osNpcTouch(LSL_Key npcLSL_Key, LSL_Key object_key, LSL_Integer link_num); void osNpcWhisper(key npc, int channel, string message); LSL_Key osOwnerSaveAppearance(string notecard); LSL_Key osAgentSaveAppearance(key agentId, string notecard); key osGetGender(LSL_Key rawAvatarId); key osGetMapTexture(); key osGetRegionMapTexture(string regionName); LSL_List osGetRegionStats(); vector osGetRegionSize(); int osGetSimulatorMemory(); int osGetSimulatorMemoryKB(); void osKickAvatar(string FirstName, string SurName, string alert); void osKickAvatar(LSL_Key agentId, string alert); void osSetSpeed(string UUID, LSL_Float SpeedModifier); void osSetOwnerSpeed(LSL_Float SpeedModifier); LSL_Float osGetHealth(key agentId); void osCauseHealing(key agentId, LSL_Float healing); void osSetHealth(key agentId, LSL_Float health); void osSetHealRate(key agentId, LSL_Float health); LSL_Float osGetHealRate(key agentId); void osCauseDamage(key avatar, LSL_Float damage); void osForceOtherSit(string avatar); void osForceOtherSit(string avatar, string target); LSL_List osGetPrimitiveParams(LSL_Key prim, LSL_List rules); void osSetPrimitiveParams(LSL_Key prim, LSL_List rules); void osSetProjectionParams(bool projection, LSL_Key texture, double fov, double focus, double amb); void osSetProjectionParams(LSL_Key prim, bool projection, LSL_Key texture, double fov, double focus, double amb); LSL_List osGetAvatarList(); LSL_List osGetNPCList(); LSL_String osUnixTimeToTimestamp(LSL_Integer time); LSL_Integer osInviteToGroup(LSL_Key agentId); LSL_Integer osEjectFromGroup(LSL_Key agentId); void osSetTerrainTexture(int level, LSL_Key texture); void osSetTerrainTextureHeight(int corner, double low, double high); /// /// Checks if thing is a UUID. /// /// /// 1 if thing is a valid UUID, 0 otherwise LSL_Integer osIsUUID(string thing); /// /// Wraps to Math.Min() /// /// /// /// LSL_Float osMin(double a, double b); /// /// Wraps to Math.max() /// /// /// /// LSL_Float osMax(double a, double b); /// /// Get the key of the object that rezzed this object. /// /// Rezzing object key or NULL_KEY if rezzed by agent or otherwise unknown. LSL_Key osGetRezzingObject(); /// /// Sets the response type for an HTTP request/response /// /// void osSetContentType(LSL_Key id, string type); /// /// Attempts to drop an attachment to the ground /// void osDropAttachment(); /// /// Attempts to drop an attachment to the ground while bypassing the script permissions /// void osForceDropAttachment(); /// /// Attempts to drop an attachment at the specified coordinates. /// /// /// void osDropAttachmentAt(vector pos, rotation rot); /// /// Attempts to drop an attachment at the specified coordinates while bypassing the script permissions /// /// /// void osForceDropAttachmentAt(vector pos, rotation rot); /// /// Identical to llListen except for a bitfield which indicates which /// string parameters should be parsed as regex patterns. /// /// /// /// /// /// /// OS_LISTEN_REGEX_NAME /// OS_LISTEN_REGEX_MESSAGE /// /// LSL_Integer osListenRegex(int channelID, string name, string ID, string msg, int regexBitfield); /// /// Wraps to bool Regex.IsMatch(string input, string pattern) /// /// string to test for match /// string to use as pattern /// boolean LSL_Integer osRegexIsMatch(string input, string pattern); LSL_String osRequestURL(LSL_List options); LSL_String osRequestSecureURL(LSL_List options); void osCollisionSound(string impact_sound, double impact_volume); void osVolumeDetect(int detect); LSL_List osGetInertiaData(); void osClearInertia(); void osSetInertia(LSL_Float mass, vector centerOfMass, vector principalInertiaScaled, rotation rot); void osSetInertiaAsBox(LSL_Float mass, vector boxSize, vector centerOfMass, rotation rot); void osSetInertiaAsSphere(LSL_Float mass, LSL_Float radius, vector centerOfMass); void osSetInertiaAsCylinder(LSL_Float mass, LSL_Float radius, LSL_Float lenght, vector centerOfMass,rotation lslrot); LSL_Integer osTeleportObject(LSL_Key objectUUID, vector targetPos, rotation targetrotation, LSL_Integer flags); LSL_Integer osGetLinkNumber(LSL_String name); LSL_Float osRound(LSL_Float value, LSL_Integer digits); LSL_Float osVecMagSquare(vector a); LSL_Float osVecDistSquare(vector a, vector b); LSL_Float osAngleBetween(vector a, vector b); void osAdjustSoundVolume(LSL_Integer linknum, LSL_Float volume); void osLoopSound(LSL_Integer linknum, LSL_String sound, LSL_Float volume); void osLoopSoundMaster(LSL_Integer linknum, LSL_String sound, LSL_Float volume); void osLoopSoundSlave(LSL_Integer linknum, LSL_String sound, LSL_Float volume); void osPlaySound(LSL_Integer linknum, LSL_String sound, LSL_Float volume); void osPlaySoundSlave(LSL_Integer linknum, LSL_String sound, LSL_Float volume); void osPreloadSound(LSL_Integer linknum, LSL_String sound); void osSetSoundRadius(LSL_Integer linknum, LSL_Float radius); void osStopSound(LSL_Integer linknum); void osTriggerSound(LSL_Integer linknum, LSL_String sound, LSL_Float volume); void osTriggerSoundLimited(LSL_Integer linknum, LSL_String sound, LSL_Float volume, vector top_north_east, vector bottom_south_west); LSL_String osDetectedCountry(LSL_Integer number); LSL_String osGetAgentCountry(LSL_Key agentId); LSL_String osStringSubString(LSL_String src, LSL_Integer start); LSL_String osStringSubString(LSL_String src, LSL_Integer start, LSL_Integer length); LSL_Integer osStringStartsWith(LSL_String src, LSL_String value, LSL_Integer ignorecase); LSL_Integer osStringEndsWith(LSL_String src, LSL_String value, LSL_Integer ignorecase); LSL_Integer osStringIndexOf(LSL_String src, LSL_String value, LSL_Integer ignorecase); LSL_Integer osStringIndexOf(LSL_String src, LSL_String value, LSL_Integer start, LSL_Integer count, LSL_Integer ignorecase); LSL_Integer osStringLastIndexOf(LSL_String src, LSL_String value, LSL_Integer ignorecase); LSL_Integer osStringLastIndexOf(LSL_String src, LSL_String value, LSL_Integer start, LSL_Integer count, LSL_Integer ignorecase); LSL_String osStringRemove(LSL_String src, LSL_Integer start, LSL_Integer count); LSL_String osStringReplace(LSL_String src, LSL_String oldvalue, LSL_String newvalue); LSL_Integer osApproxEquals(LSL_Float a, LSL_Float b); LSL_Integer osApproxEquals(LSL_Float a, LSL_Float b, LSL_Float margin); LSL_Integer osApproxEquals(vector va, vector vb); LSL_Integer osApproxEquals(vector va, vector vb, LSL_Float margin); LSL_Integer osApproxEquals(rotation ra, rotation rb); LSL_Integer osApproxEquals(rotation ra, rotation rb, LSL_Float margin); LSL_Key osGetInventoryLastOwner(LSL_String itemNameOrId); LSL_String osGetInventoryName(LSL_Key itemId); LSL_String osGetInventoryDesc(LSL_String itemNameOrId); LSL_Key osGetLastChangedEventKey(); } }