From 795c8e6c22d4174d942ad56e70a0acbe507e2ec7 Mon Sep 17 00:00:00 2001
From: Justin Clark-Casey (justincc)
Date: Tue, 9 Aug 2011 22:05:47 +0100
Subject: Add osOwnerSaveAppearance() to help with setting up NPC appearances.
Not yet ready for user use.
Adds regression test.
---
.../Shared/Api/Implementation/OSSL_Api.cs | 51 ++++++++--
.../ScriptEngine/Shared/Api/Interface/IOSSL_Api.cs | 2 +
.../ScriptEngine/Shared/Api/Runtime/OSSL_Stub.cs | 5 +
.../Shared/Tests/OSSL_ApiAppearanceTest.cs | 105 +++++++++++++++++++++
4 files changed, 153 insertions(+), 10 deletions(-)
create mode 100644 OpenSim/Region/ScriptEngine/Shared/Tests/OSSL_ApiAppearanceTest.cs
(limited to 'OpenSim')
diff --git a/OpenSim/Region/ScriptEngine/Shared/Api/Implementation/OSSL_Api.cs b/OpenSim/Region/ScriptEngine/Shared/Api/Implementation/OSSL_Api.cs
index 07b36de..a05c623 100644
--- a/OpenSim/Region/ScriptEngine/Shared/Api/Implementation/OSSL_Api.cs
+++ b/OpenSim/Region/ScriptEngine/Shared/Api/Implementation/OSSL_Api.cs
@@ -2147,14 +2147,19 @@ namespace OpenSim.Region.ScriptEngine.Shared.Api
return new LSL_Key(UUID.Zero.ToString());
}
+ ///
+ /// Save the current appearance of the NPC permanently to the named notecard.
+ ///
+ ///
+ /// The name of the notecard to which to save the appearance.
+ /// The asset ID of the notecard saved.
public LSL_Key osNpcSaveAppearance(string avatar, string notecardName)
{
CheckThreatLevel(ThreatLevel.High, "osNpcSaveAppearance");
INPCModule npcModule = World.RequestModuleInterface();
- IAvatarFactory appearanceModule = World.RequestModuleInterface();
- if (npcModule != null && appearanceModule != null)
+ if (npcModule != null)
{
UUID avatarId = UUID.Zero;
if (!UUID.TryParse(avatar, out avatarId))
@@ -2163,14 +2168,7 @@ namespace OpenSim.Region.ScriptEngine.Shared.Api
if (!npcModule.IsNPC(avatarId, m_host.ParentGroup.Scene))
return new LSL_Key(UUID.Zero.ToString());
- appearanceModule.SaveBakedTextures(avatarId);
- ScenePresence sp = m_host.ParentGroup.Scene.GetScenePresence(avatarId);
- OSDMap appearancePacked = sp.Appearance.Pack();
-
- TaskInventoryItem item
- = SaveNotecard(notecardName, "Avatar Appearance", Util.GetFormattedXml(appearancePacked as OSD), true);
-
- return new LSL_Key(item.AssetID.ToString());
+ return SaveAppearanceToNotecard(avatarId, notecardName);
}
return new LSL_Key(UUID.Zero.ToString());
@@ -2236,6 +2234,39 @@ namespace OpenSim.Region.ScriptEngine.Shared.Api
module.DeleteNPC(new UUID(npc.m_string), World);
}
}
+
+ ///
+ /// Save the current appearance of the script owner permanently to the named notecard.
+ ///
+ /// The name of the notecard to which to save the appearance.
+ /// The asset ID of the notecard saved.
+ public LSL_Key osOwnerSaveAppearance(string notecardName)
+ {
+ CheckThreatLevel(ThreatLevel.High, "osOwnerSaveAppearance");
+
+ return SaveAppearanceToNotecard(m_host.OwnerID, notecardName);
+ }
+
+ protected LSL_Key SaveAppearanceToNotecard(UUID avatarId, string notecardName)
+ {
+ IAvatarFactory appearanceModule = World.RequestModuleInterface();
+
+ if (appearanceModule != null)
+ {
+ appearanceModule.SaveBakedTextures(m_host.OwnerID);
+ ScenePresence sp = m_host.ParentGroup.Scene.GetScenePresence(m_host.OwnerID);
+ OSDMap appearancePacked = sp.Appearance.Pack();
+
+ TaskInventoryItem item
+ = SaveNotecard(notecardName, "Avatar Appearance", Util.GetFormattedXml(appearancePacked as OSD), true);
+
+ return new LSL_Key(item.AssetID.ToString());
+ }
+ else
+ {
+ return new LSL_Key(UUID.Zero.ToString());
+ }
+ }
///
/// Get current region's map texture UUID
diff --git a/OpenSim/Region/ScriptEngine/Shared/Api/Interface/IOSSL_Api.cs b/OpenSim/Region/ScriptEngine/Shared/Api/Interface/IOSSL_Api.cs
index 868af27..92473ae 100644
--- a/OpenSim/Region/ScriptEngine/Shared/Api/Interface/IOSSL_Api.cs
+++ b/OpenSim/Region/ScriptEngine/Shared/Api/Interface/IOSSL_Api.cs
@@ -176,6 +176,8 @@ namespace OpenSim.Region.ScriptEngine.Shared.Api.Interfaces
void osNpcSay(key npc, string message);
void osNpcRemove(key npc);
+ LSL_Key osOwnerSaveAppearance(string notecardName);
+
key osGetMapTexture();
key osGetRegionMapTexture(string regionName);
LSL_List osGetRegionStats();
diff --git a/OpenSim/Region/ScriptEngine/Shared/Api/Runtime/OSSL_Stub.cs b/OpenSim/Region/ScriptEngine/Shared/Api/Runtime/OSSL_Stub.cs
index 959b5d5..4b21c88 100644
--- a/OpenSim/Region/ScriptEngine/Shared/Api/Runtime/OSSL_Stub.cs
+++ b/OpenSim/Region/ScriptEngine/Shared/Api/Runtime/OSSL_Stub.cs
@@ -508,6 +508,11 @@ namespace OpenSim.Region.ScriptEngine.Shared.ScriptBase
m_OSSL_Functions.osNpcRemove(npc);
}
+ public LSL_Key osOwnerSaveAppearance(string notecardName)
+ {
+ return m_OSSL_Functions.osOwnerSaveAppearance(notecardName);
+ }
+
public OSSLPrim Prim;
[Serializable]
diff --git a/OpenSim/Region/ScriptEngine/Shared/Tests/OSSL_ApiAppearanceTest.cs b/OpenSim/Region/ScriptEngine/Shared/Tests/OSSL_ApiAppearanceTest.cs
new file mode 100644
index 0000000..fc8b551
--- /dev/null
+++ b/OpenSim/Region/ScriptEngine/Shared/Tests/OSSL_ApiAppearanceTest.cs
@@ -0,0 +1,105 @@
+/*
+ * 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.Generic;
+using System.Text;
+using Nini.Config;
+using NUnit.Framework;
+using OpenMetaverse;
+using OpenMetaverse.Assets;
+using OpenMetaverse.StructuredData;
+using OpenSim.Framework;
+using OpenSim.Region.CoreModules.Avatar.AvatarFactory;
+using OpenSim.Region.Framework.Scenes;
+using OpenSim.Region.ScriptEngine.Shared;
+using OpenSim.Region.ScriptEngine.Shared.Api;
+using OpenSim.Services.Interfaces;
+using OpenSim.Tests.Common;
+using OpenSim.Tests.Common.Mock;
+
+namespace OpenSim.Region.ScriptEngine.Shared.Tests
+{
+ ///
+ /// Tests for OSSL_Api
+ ///
+ [TestFixture]
+ public class OSSL_ApiAppearanceTest
+ {
+ [Test]
+ public void TestOsOwnerSaveAppearance()
+ {
+ TestHelpers.InMethod();
+// log4net.Config.XmlConfigurator.Configure();
+
+ IConfigSource initConfigSource = new IniConfigSource();
+ IConfig config = initConfigSource.AddConfig("XEngine");
+ config.Set("Enabled", "true");
+ config.Set("AllowOSFunctions", "true");
+ config.Set("OSFunctionThreatLevel", "Severe");
+
+ UUID userId = TestHelpers.ParseTail(0x1);
+ float newHeight = 1.9f;
+
+ Scene scene = SceneHelpers.SetupScene();
+ SceneHelpers.SetupSceneModules(scene, new AvatarFactoryModule());
+ ScenePresence sp = SceneHelpers.AddScenePresence(scene, userId);
+ sp.Appearance.AvatarHeight = newHeight;
+ SceneObjectGroup so = SceneHelpers.CreateSceneObject(1, userId);
+ SceneObjectPart part = so.RootPart;
+ scene.AddSceneObject(so);
+
+ XEngine.XEngine engine = new XEngine.XEngine();
+ engine.Initialise(initConfigSource);
+ engine.AddRegion(scene);
+
+ OSSL_Api osslApi = new OSSL_Api();
+ osslApi.Initialize(engine, part, part.LocalId, part.UUID);
+
+ string notecardName = "appearanceNc";
+
+ osslApi.osOwnerSaveAppearance(notecardName);
+
+ IList items = part.Inventory.GetInventoryItems(notecardName);
+ Assert.That(items.Count, Is.EqualTo(1));
+
+ TaskInventoryItem ncItem = items[0];
+ Assert.That(ncItem.Name, Is.EqualTo(notecardName));
+
+ AssetBase ncAsset = scene.AssetService.Get(ncItem.AssetID.ToString());
+ Assert.That(ncAsset, Is.Not.Null);
+
+ AssetNotecard anc = new AssetNotecard(UUID.Zero, ncAsset.Data);
+ anc.Decode();
+ OSDMap appearanceOsd = (OSDMap)OSDParser.DeserializeLLSDXml(anc.BodyText);
+ AvatarAppearance savedAppearance = new AvatarAppearance();
+ savedAppearance.Unpack(appearanceOsd);
+
+ Assert.That(savedAppearance.AvatarHeight, Is.EqualTo(sp.Appearance.AvatarHeight));
+ }
+ }
+}
\ No newline at end of file
--
cgit v1.1