Difference between revisions of "LlForceMouselook"

From Second Life Wiki
Jump to navigation Jump to search
m
 
(26 intermediate revisions by 9 users not shown)
Line 1: Line 1:
{{LSL_Function
{{LSL_Function
|inject-2={{LSL Function/boolean|mouselook|bool=*|if=*|default=false|td=when an avatar sits on the prim, the avatar will be forced into [[mouselook]] mode||fd=the avatar will keep their current camera mode.|th=when an avatar sits on the prim, the avatar will be forced into mouselook mode}}
|func_id=294|func_sleep=0.0|func_energy=10.0
|func_id=294|func_sleep=0.0|func_energy=10.0
|func=llForceMouselook
|func=llForceMouselook
|p1_type=integer
|p1_type=integer|p1_subtype=boolean|p1_name=mouselook
|p1_name=mouselook
|p1_desc
|p1_desc=boolean, If {{LSLG|TRUE}} any avatar that sits on this object is forced into {{LSLG|mouselook}} mode.<br/>{{LSLG|FALSE}} undoes this setting.
|func_footnote=A [[llSitTarget|sit target]] is not necessary for this function to work.
|func_footnote
|func_desc=Sets if a sitting avatar should be forced into [[mouselook]] when they sit on this prim.
|func_desc=Sets if a sitting avatar should be forced into {{LSLG|mouselook}} mode upon sitting on the object.
|return_text
|return_text
|spec
|spec
|caveats=*The user may exit mouselook mode at any time.
|caveats=
**This can be detected by polling {{LSLG|llGetAgentInfo}}.
*This function has no effect on avatars already seated.
*The user may exit mouselook mode at any time.
**This can be detected by polling [[llGetAgentInfo]].
*There is nothing stopping someone from modifying or making a client that ignores this.
|constants
|constants
|examples=
|examples=
'''Force Mouselook on Sit'''
'''Force Mouselook on Sit'''
<pre>
<source lang="lsl2">default
default
{
{
     changed(integer change) //event changed
     state_entry()
     {
     {
         if (change & CHANGED_LINK) //event changed and it has to do with linking or avatar sitting
         llForceMouselook(TRUE); // Forces sitting avatars into mouselook.
         if (llAvatarOnSitTarget() != NULL_KEY) //the changed event is an avatar sitting
 
        llForceMouselook(TRUE); //force into mouselook on sit
         llForceMouselook(FALSE); // Reverts the setting to the default...
                                // ...as with a newly created prim.
     }
     }
 
}</source>
}
</pre>
|helpers
|helpers
|also_functions=*{{LSLG|llAvatarOnSitTarget}}
|also_functions={{LSL DefineRow||[[llAvatarOnSitTarget]]|}}
*{{LSLG|llGetAgentInfo}}
{{LSL DefineRow||[[llGetAgentInfo]]|}}
{{LSL DefineRow||[[llGetCameraRot]]|}}
{{LSL DefineRow||[[llSetCameraAtOffset]]|}}
{{LSL DefineRow||[[llSetCameraEyeOffset]]|}}
|also_events
|also_events
|also_tests
|also_tests=
{{LSL DefineRow||[[llForceMouseLook Test]]|}}
|also_articles
|also_articles
|notes
|notes
|permission
|permission
|negative_index
|negative_index
|cat1
|cat1=Sit
|cat2
|cat2=Vehicle
|cat3
|cat3=Camera
|cat4=Stub
|cat4=Prim
|cat5=Mouselook
|cat6=Status
|cat7
|cat8
}}
}}

Latest revision as of 00:25, 22 January 2015

Summary

Function: llForceMouselook( integer mouselook );
0.0 Forced Delay
10.0 Energy

Sets if a sitting avatar should be forced into mouselook when they sit on this prim.

• integer mouselook boolean, if TRUE when an avatar sits on the prim, the avatar will be forced into mouselook mode, if FALSE (default) the avatar will keep their current camera mode.

A sit target is not necessary for this function to work.

Caveats

  • This function has no effect on avatars already seated.
  • The user may exit mouselook mode at any time.
  • There is nothing stopping someone from modifying or making a client that ignores this.

Examples

Force Mouselook on Sit

default
{
    state_entry()
    {
        llForceMouselook(TRUE); // Forces sitting avatars into mouselook.

        llForceMouselook(FALSE); // Reverts the setting to the default...
                                 // ...as with a newly created prim.
    }
}

Deep Notes

Tests

•  llForceMouseLook Test

Signature

function void llForceMouselook( integer mouselook );