Difference between revisions of "LlGetStartParameter"

From Second Life Wiki
Jump to navigation Jump to search
m
(Note that manual rez gives 0. Caveat that the parameter is lost on script reset.)
Line 6: Line 6:
*If the script was loaded with [[llRemoteLoadScriptPin]] then that start parameter is returned.
*If the script was loaded with [[llRemoteLoadScriptPin]] then that start parameter is returned.
*If the containing object was rezzed by [[llRezObject]] or [[llRezAtRoot]] then the return is the [[on_rez]] parameter.
*If the containing object was rezzed by [[llRezObject]] or [[llRezAtRoot]] then the return is the [[on_rez]] parameter.
*If the containing object was manually rezzed, by dragging from inventory, the start parameter is 0.
|func_desc
|func_desc
|return_text=that is the script start/rez parameter.
|return_text=that is the script start/rez parameter.
|spec
|spec
|caveats=
|caveats=
* The start parameter does not survive region restarts ({{Jira|SVC-2251}}) or region change ({{Jira|SVC-3258}}, crossing or teleport).  
* The start parameter does not survive region restarts ({{Jira|SVC-2251}}) or region change ({{Jira|SVC-3258}}, crossing or teleport).
* If the script is reset (using [[llResetScript]] or other means), the start parameter is set to 0.
|constants
|constants
|examples=
|examples=

Revision as of 04:25, 29 September 2010

Summary

Function: integer llGetStartParameter( );

Returns an integer that is the script start/rez parameter.

  • If the script was loaded with llRemoteLoadScriptPin then that start parameter is returned.
  • If the containing object was rezzed by llRezObject or llRezAtRoot then the return is the on_rez parameter.
  • If the containing object was manually rezzed, by dragging from inventory, the start parameter is 0.

Caveats

  • The start parameter does not survive region restarts (SVC-2251) or region change (SVC-3258, crossing or teleport).
  • If the script is reset (using llResetScript or other means), the start parameter is set to 0.
All Issues ~ Search JIRA for related Bugs

Examples

<lsl> default {

   on_rez(integer param)
   {
       llOwnerSay("rezzed with the number " + (string)param);
   }
   state_entry()
   {
       integer i = llGetStartParameter();
       if (i)
       {
           llOwnerSay("I was given the number " + (string)i + " when I was rezzed");
       }
       else
       {
           llOwnerSay("rezzed from inventory (or rezzed/loaded with 0)");
       }
   }

}

</lsl>

See Also

Events

•  on_rez

Functions

•  llRemoteLoadScriptPin Used to load a script into a remote prim
•  llRezObject Used to rez an object at the center of mass
•  llRezAtRoot Used to rez an object at the root

Deep Notes

All Issues

~ Search JIRA for related Issues
   llGetStartParameter returns zero after sim restart
   llGetStartParameter returns zero after change of region

Signature

function integer llGetStartParameter();