OsNpcCreate

From OpenSimulator

(Difference between revisions)
Jump to: navigation, search
(minimal fix of the sample script)
m (Change See Also)
 
(34 intermediate revisions by 10 users not shown)
Line 1: Line 1:
−
{{osslfunc|
+
{{osslfunc
−
threat_level = High
+
|threat_level=High
−
|
+
|permissions=${OSSL|osslNPC}
−
function_syntax = <source lang="lsl">
+
|delay=0
−
key osNpcCreate(string firstname, string lastname, vector position, key cloneFrom);
+
|function_syntax=key osNpcCreate(string firstname, string lastname, vector position, string cloneFrom)
 +
 
 +
key osNpcCreate(string firstname, string lastname, vector position, string cloneFrom, integer options)
 +
|description=*Creates an NPC named '''firstname''' '''lastname''' at '''position''' from avatar appearance resource '''cloneFrom'''
 +
|ossl_example=<source lang="lsl">
 +
//
 +
// osNpcCreate Script Exemple
 +
// Author: djphil
 +
//
 +
 
 +
key npc;
 +
 
 +
default
 +
{
 +
    state_entry()
 +
    {
 +
        llSay(PUBLIC_CHANNEL, "Touch to see osNpcCreate usage.");
 +
    }
 +
 
 +
    touch_start(integer number)
 +
    {
 +
        key toucher = llDetectedKey(0);
 +
        vector npcPos = llGetPos() + <1.0, 0.0, 1.0>;
 +
        osAgentSaveAppearance(toucher, "appearance");
 +
        npc = osNpcCreate("ImYour", "Clone", npcPos, "appearance");
 +
        state hasNPC;
 +
    }
 +
}
 +
 
 +
state hasNPC
 +
{
 +
    state_entry()
 +
    {
 +
        llSetTimerEvent(5.0);
 +
    }
 +
 
 +
    timer()
 +
    {
 +
        llSetTimerEvent(0.0);
 +
        osNpcSay(npc, "Hello world!");
 +
    }
 +
 
 +
    touch_start(integer number)
 +
    {
 +
        osNpcSay(npc, "Goodbye!");
 +
        llSetTimerEvent(0.0);
 +
        osNpcRemove(npc);
 +
        npc = NULL_KEY;
 +
        state default;
 +
    }
 +
}
 
</source>
 
</source>
−
|
+
'''With OS_NPC_SENSE_AS_AGENT:''' (It Needs the setting '''AllowSenseAsAvatar''' on '''true''' in section '''[NPC]''' of your OpenSim.ini)
−
ossl_example = <source lang="lsl">
+
<source lang="lsl">
−
default
+
//
−
{
+
// osNpcCreate Script Exemple
 +
// Authior: djphil
 +
//
 +
 
 +
integer sens_as_agent = TRUE;
 +
key npc;
 +
 
 +
default
 +
{
 +
    state_entry()
 +
    {
 +
        llSay(PUBLIC_CHANNEL, "Touch to see osNpcCreate usage.");
 +
       
 +
        if (sens_as_agent == TRUE)
 +
        {
 +
            llSay(PUBLIC_CHANNEL, "This with the use of the option OS_NPC_SENSE_AS_AGENT.");
 +
        }
 +
       
 +
        else
 +
        {
 +
            llSay(PUBLIC_CHANNEL, "This without the use of the option OS_NPC_SENSE_AS_AGENT.");
 +
        } 
 +
    }
 +
 
 
     touch_start(integer number)
 
     touch_start(integer number)
 
     {
 
     {
−
      key npc;  
+
        key toucher = llDetectedKey(0);
−
      npc = osNpcCreate("Jane", "Bot", <100,100, 40>, "c40457e2-6e89-4bca-ab4e-d781db63616a");    
+
        vector npcPos = llGetPos() + <1.0, 0.0, 1.0>;
 +
        osAgentSaveAppearance(toucher, "appearance");
 +
 
 +
        if (sens_as_agent == TRUE)
 +
        {
 +
            npc = osNpcCreate("ImYour", "Clone", npcPos, "appearance", OS_NPC_SENSE_AS_AGENT);
 +
        }
 +
 
 +
        else
 +
        {
 +
            npc = osNpcCreate("ImYour", "Clone", npcPos, "appearance");
 +
        }
 +
 
 +
        state hasNPC;
 
     }
 
     }
−
}
+
}
 +
 
 +
state hasNPC
 +
{
 +
    state_entry()
 +
    {
 +
        llSetTimerEvent(5.0);
 +
    }
 +
 
 +
    timer()
 +
    {
 +
        llSetTimerEvent(0.0);
 +
        key npc_owner = osNpcGetOwner(npc);
 +
        osNpcSay(npc, "Hello world!");
 +
 
 +
        if (sens_as_agent == TRUE)
 +
        {
 +
            llSensor("", npc, AGENT, 2.0, PI);
 +
        }
 +
 
 +
        else
 +
        {
 +
            llSensor("", npc, NPC, 2.0, PI);
 +
        }
 +
    }
 +
 
 +
    touch_start(integer number)
 +
    {
 +
        osNpcSay(npc, "Goodbye!");
 +
        llSetTimerEvent(0.0);
 +
        osNpcRemove(npc);
 +
        npc = NULL_KEY;
 +
        state default;
 +
    }
 +
 
 +
    sensor(integer number)
 +
    {
 +
        if (sens_as_agent == TRUE)
 +
        {
 +
            llSay(PUBLIC_CHANNEL, (string)number + " NPC sense as agent deteced: " + llDetectedName(0));
 +
        }
 +
 
 +
        else
 +
        {
 +
            llSay(PUBLIC_CHANNEL, (string)number + " NPC sense as npc deteted: " + llDetectedName(0));
 +
        }
 +
    }
 +
 
 +
    no_sensor()
 +
    {
 +
        if (sens_as_agent == TRUE)
 +
        {
 +
            llSay(PUBLIC_CHANNEL, "No NPC sense as agent is near me at present.");
 +
        }
 +
 
 +
        else
 +
        {
 +
            llSay(PUBLIC_CHANNEL, "No NPC senss as npc is near me at present.");
 +
        }
 +
    }
 +
}
 
</source>
 
</source>
−
|
+
'''With OS_NPC_OBJECT_GROUP:''' (It Needs the setting '''NoNPCGroup''' on '''false''' in section '''[NPC]''' of your OpenSim.ini)
−
additional_info = This function creates a NPC(Non Player Character) clone from an already existing avatar UUID Key.
+
<source lang="lsl">
 +
//
 +
// osNpcCreate Script Exemple
 +
// Authior: djphil
 +
//
  
−
'''*** This function is broken in OpenSimulator 0.7x ***'''
+
key npc;
−
|
+
 
 +
default
 +
{
 +
    state_entry()
 +
    {
 +
        llSay(PUBLIC_CHANNEL, "Touch to see osNpcCreate usage.");
 +
        llSay(PUBLIC_CHANNEL, "This with the use of the option OS_NPC_OBJECT_GROUP.");
 +
    }
 +
 
 +
    touch_start(integer number)
 +
    {
 +
        key toucher = llDetectedKey(0);
 +
        vector npcPos = llGetPos() + <1.0, 0.0, 1.0>;
 +
        osAgentSaveAppearance(toucher, "appearance");
 +
        npc = osNpcCreate("ImYour", "Clone", npcPos, "appearance", OS_NPC_OBJECT_GROUP);
 +
        state hasNPC;
 +
    }
 +
}
 +
 
 +
state hasNPC
 +
{
 +
    state_entry()
 +
    {
 +
        llSetTimerEvent(5.0);
 +
    }
 +
 
 +
    timer()
 +
    {
 +
        llSetTimerEvent(0.0);
 +
        key npc_owner = osNpcGetOwner(npc);
 +
        osNpcSay(npc, "Hello world!");       
 +
    }
 +
 
 +
    touch_start(integer number)
 +
    {
 +
        osNpcSay(npc, "Goodbye!");
 +
        llSetTimerEvent(0.0);
 +
        osNpcRemove(npc);
 +
        npc = NULL_KEY;
 +
        state default;
 +
    }
 +
}
 +
</source>
 +
|additional_info= Some more useful info:
 +
* NPC stands for Non-Player Character.
 +
* You can clone an appearance from a saved appearance notecard name or UUID, or from the UUID of an avatar logged into the same region or sim.
 +
* You can create and load appearance notecards with the following functions: [[osOwnerSaveAppearance]], [[osAgentSaveAppearance]], [[osNpcLoadAppearance]], [[osNpcSaveAppearance]].
 +
* '''In current OpenSimulator development code (from commit c4972e77 on Thu Jan 12 2012), an overloaded version of osNpcCreate() has been added.'''
 +
** This has the signature key osNpcCreate(string firstname, string lastname, vector position, string cloneFrom, integer options).
 +
** The options field can be either OS_NPC_CREATOR_OWNED or OS_NPC_NOT_OWNED. For exemples, see [[osNpcGetOwner]]
 +
** OS_NPC_CREATOR_OWNED will create an 'owned' NPC that will only respond to osNpc* commands issued from scripts that have the same owner as the one that created the NPC.
 +
** OS_NPC_NOT_OWNED will create an 'unowned' NPC that will respond to any script that has OSSL permissions to call osNpc* commands.
 +
** Example: "key npc = osNpcCreate("ImYour", "Clone", npcPos, "appearance", OS_NPC_CREATOR_OWNED);". For full exemples, see [[osNpcGetOwner]]
 +
** The existing osNpcCreate() function without the options field will continue to exist.
 +
* From git master commit 3b59af22 on Friday Jan 13 2012 (after the OpenSimulator 0.7.2 release), the avatar created by the existing osNpc* function without the options parameter will create an 'owned' NPC rather than an 'unowned' one.  Please see the discussion above for information on these terms.  This is a hopefully rare case where the behaviour of an existing function changes slightly.  If you continue to need an 'unowned' NPC, please use the OS_NPC_NOT_OWNED option described above.
 +
* Use OS_NPC_SENSE_AS_AGENT option if you would like for the created NPC to be able to be detected via a sensor and want to maintain llSensor() compatibility with type AGENT.
 +
* OS_NPC_OBJECT_GROUP  with it the npc will be created with the group of the object with the script, if that object owner is member of that group. This should allow parcel access by group to work now, and not much else. The group Title will also be set, it the region option NoNPCGroup is not active.
 +
*This function was added in 0.7.3-post-fixes
 
}}
 
}}
 +
== See Also ==
 +
* [[osNpcCreate]]
 +
* [[osNpcRemove]]

Latest revision as of 18:50, 5 December 2020

Languages Languages: 

En.png English

key osNpcCreate(string firstname, string lastname, vector position, string cloneFrom)

key osNpcCreate(string firstname, string lastname, vector position, string cloneFrom, integer options)

  • Creates an NPC named firstname lastname at position from avatar appearance resource cloneFrom
Threat Level High
Permissions ${OSSL|osslNPC}
Extra Delay 0 seconds
Example(s) 
//
// osNpcCreate Script Exemple
// Author: djphil
//
 
key npc;
 
default
{
    state_entry()
    {
        llSay(PUBLIC_CHANNEL, "Touch to see osNpcCreate usage.");
    }
 
    touch_start(integer number)
    {
        key toucher = llDetectedKey(0);
        vector npcPos = llGetPos() + <1.0, 0.0, 1.0>;
        osAgentSaveAppearance(toucher, "appearance");
        npc = osNpcCreate("ImYour", "Clone", npcPos, "appearance");
        state hasNPC;
    }
}
 
state hasNPC
{
    state_entry()
    {
        llSetTimerEvent(5.0);
    }
 
    timer()
    {
        llSetTimerEvent(0.0);
        osNpcSay(npc, "Hello world!");
    }
 
    touch_start(integer number)
    {
        osNpcSay(npc, "Goodbye!");
        llSetTimerEvent(0.0);
        osNpcRemove(npc);
        npc = NULL_KEY;
        state default;
    }
}

With OS_NPC_SENSE_AS_AGENT: (It Needs the setting AllowSenseAsAvatar on true in section [NPC] of your OpenSim.ini) 

//
// osNpcCreate Script Exemple
// Authior: djphil
//
 
integer sens_as_agent = TRUE;
key npc;
 
default
{
    state_entry()
    {
        llSay(PUBLIC_CHANNEL, "Touch to see osNpcCreate usage.");
 
        if (sens_as_agent == TRUE)
        {
            llSay(PUBLIC_CHANNEL, "This with the use of the option OS_NPC_SENSE_AS_AGENT.");
        }
 
        else
        {
            llSay(PUBLIC_CHANNEL, "This without the use of the option OS_NPC_SENSE_AS_AGENT.");
        }   
    }
 
    touch_start(integer number)
    {
        key toucher = llDetectedKey(0);
        vector npcPos = llGetPos() + <1.0, 0.0, 1.0>;
        osAgentSaveAppearance(toucher, "appearance");
 
        if (sens_as_agent == TRUE)
        {
            npc = osNpcCreate("ImYour", "Clone", npcPos, "appearance", OS_NPC_SENSE_AS_AGENT);
        }
 
        else
        {
            npc = osNpcCreate("ImYour", "Clone", npcPos, "appearance");
        }
 
        state hasNPC;
    }
}
 
state hasNPC
{
    state_entry()
    {
        llSetTimerEvent(5.0);
    }
 
    timer()
    {
        llSetTimerEvent(0.0);
        key npc_owner = osNpcGetOwner(npc);
        osNpcSay(npc, "Hello world!");
 
        if (sens_as_agent == TRUE)
        {
            llSensor("", npc, AGENT, 2.0, PI);
        }
 
        else
        {
            llSensor("", npc, NPC, 2.0, PI);
        }
    }
 
    touch_start(integer number)
    {
        osNpcSay(npc, "Goodbye!");
        llSetTimerEvent(0.0);
        osNpcRemove(npc);
        npc = NULL_KEY;
        state default;
    }
 
    sensor(integer number)
    {
        if (sens_as_agent == TRUE)
        {
            llSay(PUBLIC_CHANNEL, (string)number + " NPC sense as agent deteced: " + llDetectedName(0));
        }
 
        else
        {
            llSay(PUBLIC_CHANNEL, (string)number + " NPC sense as npc deteted: " + llDetectedName(0));
        }
    }
 
    no_sensor()
    {
        if (sens_as_agent == TRUE)
        {
            llSay(PUBLIC_CHANNEL, "No NPC sense as agent is near me at present.");
        }
 
        else
        {
            llSay(PUBLIC_CHANNEL, "No NPC senss as npc is near me at present.");
        }
    }
}

With OS_NPC_OBJECT_GROUP: (It Needs the setting NoNPCGroup on false in section [NPC] of your OpenSim.ini) 

//
// osNpcCreate Script Exemple
// Authior: djphil
//
 
key npc;
 
default
{
    state_entry()
    {
        llSay(PUBLIC_CHANNEL, "Touch to see osNpcCreate usage.");
        llSay(PUBLIC_CHANNEL, "This with the use of the option OS_NPC_OBJECT_GROUP.");
    }
 
    touch_start(integer number)
    {
        key toucher = llDetectedKey(0);
        vector npcPos = llGetPos() + <1.0, 0.0, 1.0>;
        osAgentSaveAppearance(toucher, "appearance");
        npc = osNpcCreate("ImYour", "Clone", npcPos, "appearance", OS_NPC_OBJECT_GROUP);
        state hasNPC;
    }
}
 
state hasNPC
{
    state_entry()
    {
        llSetTimerEvent(5.0);
    }
 
    timer()
    {
        llSetTimerEvent(0.0);
        key npc_owner = osNpcGetOwner(npc);
        osNpcSay(npc, "Hello world!");        
    }
 
    touch_start(integer number)
    {
        osNpcSay(npc, "Goodbye!");
        llSetTimerEvent(0.0);
        osNpcRemove(npc);
        npc = NULL_KEY;
        state default;
    }
}
Notes
Some more useful info:
  • NPC stands for Non-Player Character.
  • You can clone an appearance from a saved appearance notecard name or UUID, or from the UUID of an avatar logged into the same region or sim.
  • You can create and load appearance notecards with the following functions: osOwnerSaveAppearance, osAgentSaveAppearance, osNpcLoadAppearance, osNpcSaveAppearance.
  • In current OpenSimulator development code (from commit c4972e77 on Thu Jan 12 2012), an overloaded version of osNpcCreate() has been added.
    • This has the signature key osNpcCreate(string firstname, string lastname, vector position, string cloneFrom, integer options).
    • The options field can be either OS_NPC_CREATOR_OWNED or OS_NPC_NOT_OWNED. For exemples, see osNpcGetOwner
    • OS_NPC_CREATOR_OWNED will create an 'owned' NPC that will only respond to osNpc* commands issued from scripts that have the same owner as the one that created the NPC.
    • OS_NPC_NOT_OWNED will create an 'unowned' NPC that will respond to any script that has OSSL permissions to call osNpc* commands.
    • Example: "key npc = osNpcCreate("ImYour", "Clone", npcPos, "appearance", OS_NPC_CREATOR_OWNED);". For full exemples, see osNpcGetOwner
    • The existing osNpcCreate() function without the options field will continue to exist.
  • From git master commit 3b59af22 on Friday Jan 13 2012 (after the OpenSimulator 0.7.2 release), the avatar created by the existing osNpc* function without the options parameter will create an 'owned' NPC rather than an 'unowned' one. Please see the discussion above for information on these terms. This is a hopefully rare case where the behaviour of an existing function changes slightly. If you continue to need an 'unowned' NPC, please use the OS_NPC_NOT_OWNED option described above.
  • Use OS_NPC_SENSE_AS_AGENT option if you would like for the created NPC to be able to be detected via a sensor and want to maintain llSensor() compatibility with type AGENT.
  • OS_NPC_OBJECT_GROUP with it the npc will be created with the group of the object with the script, if that object owner is member of that group. This should allow parcel access by group to work now, and not much else. The group Title will also be set, it the region option NoNPCGroup is not active.
  • This function was added in 0.7.3-post-fixes


[edit] See Also

Retrieved from "http://opensimulator.org/index.php?title=OsNpcCreate&oldid=50319"
Personal tools
General
About This Wiki