INPCModule.cs

Go to the documentation of this file.

/*
 * 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
{
    // option flags for NPCs
    public enum NPCOptionsFlags : int
    {
        None                    = 0x00, // no flags (max restriction)
        AllowNotOwned           = 0x01, // allow NPCs to be created not Owned
        AllowSenseAsAvatar      = 0x02, // allow NPCs to set to be sensed as Avatars
        AllowCloneOtherAvatars  = 0x04, // allow NPCs to created cloning a avatar in region
        NoNPCGroup              = 0x08, // NPCs will have no group title, otherwise will have "- NPC -"
        objectGroup               = 0x10  // NPC will have host sog groupID
    }

    public interface INPC
    {
        
        bool SenseAsAgent { get; }
        UUID ActiveGroupId { get; set; }
    }

    public interface INPCModule
    {
        UUID CreateNPC(string firstname, string lastname, Vector3 position,
                UUID owner, bool senseAsAgent, Scene scene,
                AvatarAppearance appearance);

        UUID CreateNPC(string firstname, string lastname,
                Vector3 position, UUID agentID, UUID owner, bool senseAsAgent, Scene scene,
                AvatarAppearance appearance);

        bool IsNPC(UUID agentID, Scene scene);

        INPC GetNPC(UUID agentID, Scene scene);

        bool CheckPermissions(UUID npcID, UUID callerID);

        bool SetNPCAppearance(UUID agentID, AvatarAppearance appearance,
                Scene scene);

        bool MoveToTarget(UUID agentID, Scene scene, Vector3 pos, bool noFly,
                bool landAtTarget, bool running);

        bool StopMoveToTarget(UUID agentID, Scene scene);

        bool Say(UUID agentID, Scene scene, string text);

        bool Say(UUID agentID, Scene scene, string text, int channel);

        bool Shout(UUID agentID, Scene scene, string text, int channel);

        bool Whisper(UUID agentID, Scene scene, string text, int channel);

        bool Sit(UUID agentID, UUID partID, Scene scene);

        bool Stand(UUID agentID, Scene scene);

        bool Touch(UUID agentID, UUID partID);

        bool DeleteNPC(UUID agentID, Scene scene);

        UUID GetOwner(UUID agentID);
 
        NPCOptionsFlags NPCOptionFlags {get;}
    }
}