123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105 |
- /*
- * 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 OpenMetaverse;
- using OpenSim.Framework;
- using OpenSim.Region.Framework.Scenes;
- namespace OpenSim.Region.Framework.Interfaces
- {
- public interface INPCModule
- {
- /// <summary>
- /// Create an NPC
- /// </summary>
- /// <param name="firstname"></param>
- /// <param name="lastname"></param>
- /// <param name="position"></param>
- /// <param name="scene"></param>
- /// <param name="appearance">The avatar appearance to use for the new NPC.</param>
- /// <returns>The UUID of the ScenePresence created.</returns>
- UUID CreateNPC(string firstname, string lastname, Vector3 position, Scene scene, AvatarAppearance appearance);
- /// <summary>
- /// Check if the agent is an NPC.
- /// </summary>
- /// <param name="agentID"></param>
- /// <param name="scene"></param>
- /// <returns>True if the agent is an NPC in the given scene. False otherwise.</returns>
- bool IsNPC(UUID agentID, Scene scene);
- /// <summary>
- /// Set the appearance for an NPC.
- /// </summary>
- /// <param name="agentID"></param>
- /// <param name="appearance"></param>
- /// <param name="scene"></param>
- /// <returns>True if the operation succeeded, false if there was no such agent or the agent was not an NPC</returns>
- bool SetNPCAppearance(UUID agentID, AvatarAppearance appearance, Scene scene);
- /// <summary>
- /// Move an NPC to a target over time.
- /// </summary>
- /// <param name="agentID">The UUID of the NPC</param>
- /// <param name="scene"></param>
- /// <param name="pos"></param>
- /// <param name="noFly">
- /// If true, then the avatar will attempt to walk to the location even if it's up in the air.
- /// This is to allow walking on prims.
- /// </param>
- /// <param name="landAtTarget">
- /// If true and the avatar is flying when it reaches the target, land.
- /// </param>
- /// <returns>True if the operation succeeded, false if there was no such agent or the agent was not an NPC</returns>
- bool MoveToTarget(UUID agentID, Scene scene, Vector3 pos, bool noFly, bool landAtTarget);
- /// <summary>
- /// Stop the NPC's current movement.
- /// </summary>
- /// <param name="agentID">The UUID of the NPC</param>
- /// <param name="scene"></param>
- /// <returns>True if the operation succeeded, false if there was no such agent or the agent was not an NPC</returns>
- bool StopMoveToTarget(UUID agentID, Scene scene);
- /// <summary>
- /// Get the NPC to say something.
- /// </summary>
- /// <param name="agentID">The UUID of the NPC</param>
- /// <param name="scene"></param>
- /// <param name="text"></param>
- /// <returns>True if the operation succeeded, false if there was no such agent or the agent was not an NPC</returns>
- bool Say(UUID agentID, Scene scene, string text);
- /// <summary>
- /// Delete an NPC.
- /// </summary>
- /// <param name="agentID">The UUID of the NPC</param>
- /// <param name="scene"></param>
- /// <returns>True if the operation succeeded, false if there was no such agent or the agent was not an NPC</returns>
- bool DeleteNPC(UUID agentID, Scene scene);
- }
- }
|