Difference between revisions of "LlGetStartParameter"

Revision as of 07:35, 20 March 2007

Function: integer llGetStartParameter( );


0.0	Forced Delay
10.0	Energy

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.

Signature
function integer llGetStartParameter();

@@ Line 3: / Line 3: @@
 |sort=GetStartParameter
 |func=llGetStartParameter|return_type=integer
-|func_footnote
+|func_footnote=
+*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.
 |func_desc
-|return_text=that is the start parameter passed to {{LSLG|llRezObject}} or {{LSLG|llRezAtRoot}} if the object was rezzed by a script or zero if the object was rezzed from a user's inventory. If a script was placed into an existing object by {{LSLG|llRemoteLoadScriptPin}} then in that script llGetStartParameter returns the start parameter passed into {{LSLG|llRemoteLoadScriptPin}}. If a script is reset then llGetStartParameter will return zero.
+|return_text=that is the script start/rez parameter.
 |spec
 |caveats

•	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