Second Life Wiki - User contributions [en]

LlListen

2020-11-12T06:05:30Z

Phate Shepherd:

{{LSL_Function
|inject-2={{LSL_Function/uuid|id|pd=filter for specific}}{{LSL Function/chat|channel|msg|input=*|pd=filter for specific}}{{Issues/SVC-3170}}{{Issues/SVC-92}}{{Issues/BUG-3291}}
|func=llListen
|sort=Listen
|func_id=25|func_sleep=0.0|func_energy=10.0
|return_type=integer
|return_subtype=handle
|return_text=that can be used to [[llListenControl|deactivate]] or [[llListenRemove|remove]] the listen.
|p1_type=integer|p1_name=channel|p1_desc= (-2147483648 through 2147483647)|p1_hover= (-2147483648 through 2147483647)
|p2_type=string|p2_name=name|p2_desc=filter for specific prim name or avatar {{LSLGC|Avatar/Name|legacy name}}
|p2_hover=filter for specific prim name or avatar legacy name
|p3_type=key|p3_name=id
|p4_type=string|p4_name=msg
|func_desc=Sets a [http://foldoc.org/index.cgi?query=handle handle] for {{LSLP|msg}} on {{LSLP|channel}} from {{LSLP|name}} and {{LSLP|id}}.
|func_footnote=If {{LSLP|msg}}, {{LSLP|name}} or {{LSLP|id}} are blank (i.e. <code>""</code>) they are not used to filter incoming messages.
If {{LSLP|id}} is an invalid key or assigned the value [[NULL_KEY]], it is considered blank as well. 
|spec=For the [[listen]] [[event]] to be triggered it must first match the criteria set forth by the filters; only when all the criteria have been met is a listen event generated. First the message must have been transmitted on {{LSLP|channel}}. If {{LSLP|id}} is both a [[key#valid|valid]] key and not a [[key#null key|null]] key then the speaker's key must be equivalent{{Footnote|In general terms this means the matching for {{LSLP|id}} is not case sensitive. See [[key#equivalency]] for details on key equivalency.|In general terms this means the matching for id is not case sensitive.}} to {{LSLP|id}}. If {{LSLP|name}} is set then the speaker's {{LSLGC|Avatar/Name|legacy name}} must match {{LSLP|name}} exactly (case sensitive). If {{LSLP|msg}} is set then the spoken message must match {{LSLP|msg}} exactly (case sensitive).
|also_functions={{LSL DefineRow||[[llListenRemove]]|Removes a listen}}
{{LSL DefineRow||[[llListenControl]]|Enables/Disables a listen}}
{{LSL DefineRow||[[llWhisper]]|Sends chat limited to 10 meters}}
{{LSL DefineRow||[[llSay]]|Sends chat limited to 20 meters}}
{{LSL DefineRow||[[llShout]]|Sends chat limited to 100 meters}}
{{LSL DefineRow||[[llRegionSay]]|Sends chat limited current sim}}
{{LSL DefineRow||[[llRegionSayTo]]|Sends chat region wide to a specific avatar, or their attachments, or to a rezzed object of known UUID}}
|also_events={{LSL DefineRow||[[listen]]|}}
|also_tests
|also_articles
|haiku=
{{Haiku|Choose not much to say|Someone might overhear it|Blab no big secrets}}
|notes=*Avoid channel zero (PUBLIC_CHANNEL) and set {{LSLP|name}} or {{LSLP|id}} where possible to avoid lag. <code>llListen(0, "", NULL_KEY,"")</code> can be laggy as it listens to all chat from everyone in chat range and so should be avoided.

*In November 2007, [[User:Kelly_Linden|Kelly Linden]] offered [https://lists.secondlife.com/pipermail/secondlifescripters/2007-November/001993.html this explanation] to help scripters plan listeners more efficiently:
:#Chat that is said gets added to a history.
:#A script that is running and has a [[listen]] [[event]] will ask the history for a chat message during its slice of run time.
:# When the script asks the history for a chat message the checks are done in this order:
:#* {{LSLP|channel}}
:#* self chat (prims can't hear themselves)
:#* distance/[[llRegionSay|RegionSay]]
:#* {{LSLP|id}}
:#* {{LSLP|name}}
:#* {{LSLP|msg}}
:# If a {{LSLP|msg}} is found then a [[listen]] [[event]] is added to the [[event]] queue.
:
:The {{LSLP|id}}/{{LSLP|name}}/{{LSLP|msg}} checks only happen at all if those are specified of course.
:
:So, the most efficient communication method is [[llRegionSay]] on a rarely used {{LSLP|channel}}.
:Nowadays, [[llRegionSayTo]] is to be preferred, where appropriate.
*The integer returned can be assigned to a variable (then called a handle) and used to control the listen via [[llListenRemove]] or [[llListenControl]]. These handles are assigned sequentially starting at <tt>+1</tt> through to <tt>+2,147,483,647</tt>, going beyond which, according to [[User:Simon Linden|Simon Linden]], will roll the returned integer over to <tt>−2,147,483,648</tt>, when positive incrementation resumes. If an [[llListen]] is repeated with the exact same filters as a currently active listener, then the same handle number is returned. If an [[llListen|llListen's]] filters do not match any currently active listener, then the next handle in sequence is allocated (it will not re-allocate a recently removed handle).
*If you are using multiple listens in one script, each listen can be assigned its own handle with which to control it.
|caveats=*On [[state]] change or [[llResetScript|script reset]] all listens are removed automatically.
**A [[state]] change can be used as a shortcut to releasing listens.
*Only 65 listens can simultaneously be open in any single script.
**If this number is exceeded ''Script run-time error'' and ''Too Many Listens'' errors occur.
*For some time the official SL viewer and several third party viewers can use negative channels from the chat bar directly just as any other non-zero channel. Formerly, the standard SL viewer could only send chat on negative channels through [[llDialog]] or [[llTextBox]] responses, meaning negative channels were best suited for applications that did not require direct avatar chat.
* Messages sent by script on positive and negative channels are truncated to 1024 bytes. Messages sent by chat on positive channels are truncated to 1023 bytes. Messages sent by chat from negative channels are truncated to 254 bytes.
*Once a [[listen]] is registered its filters cannot be updated, if the listen is registered to [[llGetOwner]], the listen will remain registered to the old owner upon owner change.
**[[CHANGED_OWNER|Owner change]] can be detected with the [[changed]] event.
**To work around this the old listen will need to be closed and a new one opened for the new owner.
*A prim cannot hear/listen to chat it generates. It can, however, hear a linked prim.
**Chat indirectly generated (as a result of [[llDialog]], [[llTextBox]] or from a [[Link|linked prim]]) can be heard if in range.
|examples=
Trivial example to listen to any chat from the object owner and respond once.
{{{!}} class="sortable" width="100%" {{Prettytable}}
{{!}}- {{Hl2}}
! '''Single listen handle'''
{{!}}-
{{!!}}<source lang="lsl2">
// Says beep to owner the first time owner says something in main chat
// and then stops listening

integer listenHandle;

remove_listen_handle()
{
llListenRemove(listenHandle);
}

default
{
state_entry()
{
// Change the channel number to a positive integer
// to listen for '/5 hello' style of chat.

// target only the owner's chat on channel 0 (PUBLIC_CHANNEL)
listenHandle = llListen(0, "", llGetOwner(), "");
}

listen(integer channel, string name, key id, string message)
{
// we filtered to only listen on channel 0
// to the owner's chat in the llListen call above

llOwnerSay("beep");

// stop listening until script is reset
remove_listen_handle();
}

on_rez(integer start_param)
{
llResetScript();
}

changed(integer change)
{
if (change & CHANGED_OWNER)
{
llResetScript();
}
}
}
</source>
{{!}}}

{{{!}} class="sortable" width="100%" {{Prettytable}}
{{!}}- {{Hl2}}
! '''Two listen handles'''
{{!}}-
{{!!}}<source lang="lsl2">
// Opens two listen handles upon touch_start and
// stops listening whenever something heard passes either filter

integer listenHandle_a;
integer listenHandle_b;

remove_listen_handles()
{
llListenRemove(listenHandle_a);
llListenRemove(listenHandle_b);
}

default
{
touch_start(integer num_detected)
{
key id = llDetectedKey(0);
string name = llDetectedName(0);

listenHandle_a = llListen(5, "", id, "");
listenHandle_b = llListen(6, "", NULL_KEY, "");

llSay(0, "Listening now to '" + name + "' on channel 5.");
llSay(0, "Listening now to anybody/anything on channel 6.");
}

listen(integer channel, string name, key id, string message)
{
if (channel == 5)
llSay(0, name + " said: '/5 " + message + "'");

if (channel == 6)
llSay(0, name + " said: '/6 " + message + "'");

remove_listen_handles();
}
}
</source>
{{!}}}
|cat1=Communications
|cat2=Chat
|cat3=Legacy Name/As A Parameter
|cat4=Error
}}

LlListen

2020-11-12T06:01:51Z

Phate Shepherd:

{{LSL_Function
|inject-2={{LSL_Function/uuid|id|pd=filter for specific}}{{LSL Function/chat|channel|msg|input=*|pd=filter for specific}}{{Issues/SVC-3170}}{{Issues/SVC-92}}{{Issues/BUG-3291}}
|func=llListen
|sort=Listen
|func_id=25|func_sleep=0.0|func_energy=10.0
|return_type=integer
|return_subtype=handle
|return_text=that can be used to [[llListenControl|deactivate]] or [[llListenRemove|remove]] the listen.
|p1_type=integer|p1_name=channel|p1_desc= (-2147483648 through 2147483647)|p1_hover= (-2147483648 through 2147483647)
|p2_type=string|p2_name=name|p2_desc=filter for specific prim name or avatar {{LSLGC|Avatar/Name|legacy name}}
|p2_hover=filter for specific prim name or avatar legacy name
|p3_type=key|p3_name=id
|p4_type=string|p4_name=msg
|func_desc=Sets a [http://foldoc.org/index.cgi?query=handle handle] for {{LSLP|msg}} on {{LSLP|channel}} from {{LSLP|name}} and {{LSLP|id}}.
|func_footnote=If {{LSLP|msg}}, {{LSLP|name}} or {{LSLP|id}} are blank (i.e. <code>""</code>) they are not used to filter incoming messages.
If {{LSLP|id}} is an invalid key or assigned the value [[NULL_KEY]], it is considered blank as well. 
|spec=For the [[listen]] [[event]] to be triggered it must first match the criteria set forth by the filters; only when all the criteria have been met is a listen event generated. First the message must have been transmitted on {{LSLP|channel}}. If {{LSLP|id}} is both a [[key#valid|valid]] key and not a [[key#null key|null]] key then the speaker's key must be equivalent{{Footnote|In general terms this means the matching for {{LSLP|id}} is not case sensitive. See [[key#equivalency]] for details on key equivalency.|In general terms this means the matching for id is not case sensitive.}} to {{LSLP|id}}. If {{LSLP|name}} is set then the speaker's {{LSLGC|Avatar/Name|legacy name}} must match {{LSLP|name}} exactly (case sensitive). If {{LSLP|msg}} is set then the spoken message must match {{LSLP|msg}} exactly (case sensitive).
|also_functions={{LSL DefineRow||[[llListenRemove]]|Removes a listen}}
{{LSL DefineRow||[[llListenControl]]|Enables/Disables a listen}}
{{LSL DefineRow||[[llWhisper]]|Sends chat limited to 10 meters}}
{{LSL DefineRow||[[llSay]]|Sends chat limited to 20 meters}}
{{LSL DefineRow||[[llShout]]|Sends chat limited to 100 meters}}
{{LSL DefineRow||[[llRegionSay]]|Sends chat limited current sim}}
{{LSL DefineRow||[[llRegionSayTo]]|Sends chat region wide to a specific avatar, or their attachments, or to a rezzed object of known UUID}}
|also_events={{LSL DefineRow||[[listen]]|}}
|also_tests
|also_articles
|haiku=
{{Haiku|Choose not much to say|Someone might overhear it|Blab no big secrets}}
|notes=*Avoid channel zero (PUBLIC_CHANNEL) and set {{LSLP|name}} or {{LSLP|id}} where possible to avoid lag. <code>llListen(0, "", NULL_KEY,"")</code> can be laggy as it listens to all chat from everyone in chat range and so should be avoided.

*In November 2007, [[User:Kelly_Linden|Kelly Linden]] offered [https://lists.secondlife.com/pipermail/secondlifescripters/2007-November/001993.html this explanation] to help scripters plan listeners more efficiently:
:#Chat that is said gets added to a history.
:#A script that is running and has a [[listen]] [[event]] will ask the history for a chat message during its slice of run time.
:# When the script asks the history for a chat message the checks are done in this order:
:#* {{LSLP|channel}}
:#* self chat (prims can't hear themselves)
:#* distance/[[llRegionSay|RegionSay]]
:#* {{LSLP|id}}
:#* {{LSLP|name}}
:#* {{LSLP|msg}}
:# If a {{LSLP|msg}} is found then a [[listen]] [[event]] is added to the [[event]] queue.
:
:The {{LSLP|id}}/{{LSLP|name}}/{{LSLP|msg}} checks only happen at all if those are specified of course.
:
:So, the most efficient communication method is [[llRegionSay]] on a rarely used {{LSLP|channel}}.
:Nowadays, [[llRegionSayTo]] is to be preferred, where appropriate.
*The integer returned can be assigned to a variable (then called a handle) and used to control the listen via [[llListenRemove]] or [[llListenControl]]. These handles are assigned sequentially starting at <tt>+1</tt> through to <tt>+2,147,483,647</tt>, going beyond which, according to [[User:Simon Linden|Simon Linden]], will roll the returned integer over to <tt>−2,147,483,648</tt>, when positive incrementation resumes. If an [[llListen]] is repeated with the exact same filters as a currently active listener, then the same handle number is returned. If an [[llListen|llListen's]] filters do not match any currently active listener, then the next handle in sequence is allocated (it will not re-allocate a recently removed handle).
*If you are using multiple listens in one script, each listen can be assigned its own handle with which to control it.
|caveats=*On [[state]] change or [[llResetScript|script reset]] all listens are removed automatically.
**A [[state]] change can be used as a shortcut to releasing listens.
*Only 65 listens can simultaneously be open in any single script.
**If this number is exceeded ''Script run-time error'' and ''Too Many Listens'' errors occur.
*For some time the official SL viewer and several third party viewers can use negative channels from the chat bar directly just as any other non-zero channel. Formerly, the standard SL viewer could only send chat on negative channels through [[llDialog]] or [[llTextBox]] responses, meaning negative channels were best suited for applications that did not require direct avatar chat.
* Messages sent by script on positive and negative channels are truncated to 1024 bytes. Chat received from positive channels is truncated to 1023 bytes. Chat received from negative channels is truncated to 254 bytes.
*Once a [[listen]] is registered its filters cannot be updated, if the listen is registered to [[llGetOwner]], the listen will remain registered to the old owner upon owner change.
**[[CHANGED_OWNER|Owner change]] can be detected with the [[changed]] event.
**To work around this the old listen will need to be closed and a new one opened for the new owner.
*A prim cannot hear/listen to chat it generates. It can, however, hear a linked prim.
**Chat indirectly generated (as a result of [[llDialog]], [[llTextBox]] or from a [[Link|linked prim]]) can be heard if in range.
|examples=
Trivial example to listen to any chat from the object owner and respond once.
{{{!}} class="sortable" width="100%" {{Prettytable}}
{{!}}- {{Hl2}}
! '''Single listen handle'''
{{!}}-
{{!!}}<source lang="lsl2">
// Says beep to owner the first time owner says something in main chat
// and then stops listening

integer listenHandle;

remove_listen_handle()
{
llListenRemove(listenHandle);
}

default
{
state_entry()
{
// Change the channel number to a positive integer
// to listen for '/5 hello' style of chat.

// target only the owner's chat on channel 0 (PUBLIC_CHANNEL)
listenHandle = llListen(0, "", llGetOwner(), "");
}

listen(integer channel, string name, key id, string message)
{
// we filtered to only listen on channel 0
// to the owner's chat in the llListen call above

llOwnerSay("beep");

// stop listening until script is reset
remove_listen_handle();
}

on_rez(integer start_param)
{
llResetScript();
}

changed(integer change)
{
if (change & CHANGED_OWNER)
{
llResetScript();
}
}
}
</source>
{{!}}}

{{{!}} class="sortable" width="100%" {{Prettytable}}
{{!}}- {{Hl2}}
! '''Two listen handles'''
{{!}}-
{{!!}}<source lang="lsl2">
// Opens two listen handles upon touch_start and
// stops listening whenever something heard passes either filter

integer listenHandle_a;
integer listenHandle_b;

remove_listen_handles()
{
llListenRemove(listenHandle_a);
llListenRemove(listenHandle_b);
}

default
{
touch_start(integer num_detected)
{
key id = llDetectedKey(0);
string name = llDetectedName(0);

listenHandle_a = llListen(5, "", id, "");
listenHandle_b = llListen(6, "", NULL_KEY, "");

llSay(0, "Listening now to '" + name + "' on channel 5.");
llSay(0, "Listening now to anybody/anything on channel 6.");
}

listen(integer channel, string name, key id, string message)
{
if (channel == 5)
llSay(0, name + " said: '/5 " + message + "'");

if (channel == 6)
llSay(0, name + " said: '/6 " + message + "'");

remove_listen_handles();
}
}
</source>
{{!}}}
|cat1=Communications
|cat2=Chat
|cat3=Legacy Name/As A Parameter
|cat4=Error
}}

LlListen

2020-11-12T05:58:13Z

Phate Shepherd:

{{LSL_Function
|inject-2={{LSL_Function/uuid|id|pd=filter for specific}}{{LSL Function/chat|channel|msg|input=*|pd=filter for specific}}{{Issues/SVC-3170}}{{Issues/SVC-92}}{{Issues/BUG-3291}}
|func=llListen
|sort=Listen
|func_id=25|func_sleep=0.0|func_energy=10.0
|return_type=integer
|return_subtype=handle
|return_text=that can be used to [[llListenControl|deactivate]] or [[llListenRemove|remove]] the listen.
|p1_type=integer|p1_name=channel|p1_desc= (-2147483648 through 2147483647)|p1_hover= (-2147483648 through 2147483647)
|p2_type=string|p2_name=name|p2_desc=filter for specific prim name or avatar {{LSLGC|Avatar/Name|legacy name}}
|p2_hover=filter for specific prim name or avatar legacy name
|p3_type=key|p3_name=id
|p4_type=string|p4_name=msg
|func_desc=Sets a [http://foldoc.org/index.cgi?query=handle handle] for {{LSLP|msg}} on {{LSLP|channel}} from {{LSLP|name}} and {{LSLP|id}}.
|func_footnote=If {{LSLP|msg}}, {{LSLP|name}} or {{LSLP|id}} are blank (i.e. <code>""</code>) they are not used to filter incoming messages.
If {{LSLP|id}} is an invalid key or assigned the value [[NULL_KEY]], it is considered blank as well. 
|spec=For the [[listen]] [[event]] to be triggered it must first match the criteria set forth by the filters; only when all the criteria have been met is a listen event generated. First the message must have been transmitted on {{LSLP|channel}}. If {{LSLP|id}} is both a [[key#valid|valid]] key and not a [[key#null key|null]] key then the speaker's key must be equivalent{{Footnote|In general terms this means the matching for {{LSLP|id}} is not case sensitive. See [[key#equivalency]] for details on key equivalency.|In general terms this means the matching for id is not case sensitive.}} to {{LSLP|id}}. If {{LSLP|name}} is set then the speaker's {{LSLGC|Avatar/Name|legacy name}} must match {{LSLP|name}} exactly (case sensitive). If {{LSLP|msg}} is set then the spoken message must match {{LSLP|msg}} exactly (case sensitive).
|also_functions={{LSL DefineRow||[[llListenRemove]]|Removes a listen}}
{{LSL DefineRow||[[llListenControl]]|Enables/Disables a listen}}
{{LSL DefineRow||[[llWhisper]]|Sends chat limited to 10 meters}}
{{LSL DefineRow||[[llSay]]|Sends chat limited to 20 meters}}
{{LSL DefineRow||[[llShout]]|Sends chat limited to 100 meters}}
{{LSL DefineRow||[[llRegionSay]]|Sends chat limited current sim}}
{{LSL DefineRow||[[llRegionSayTo]]|Sends chat region wide to a specific avatar, or their attachments, or to a rezzed object of known UUID}}
|also_events={{LSL DefineRow||[[listen]]|}}
|also_tests
|also_articles
|haiku=
{{Haiku|Choose not much to say|Someone might overhear it|Blab no big secrets}}
|notes=*Avoid channel zero (PUBLIC_CHANNEL) and set {{LSLP|name}} or {{LSLP|id}} where possible to avoid lag. <code>llListen(0, "", NULL_KEY,"")</code> can be laggy as it listens to all chat from everyone in chat range and so should be avoided.

*In November 2007, [[User:Kelly_Linden|Kelly Linden]] offered [https://lists.secondlife.com/pipermail/secondlifescripters/2007-November/001993.html this explanation] to help scripters plan listeners more efficiently:
:#Chat that is said gets added to a history.
:#A script that is running and has a [[listen]] [[event]] will ask the history for a chat message during its slice of run time.
:# When the script asks the history for a chat message the checks are done in this order:
:#* {{LSLP|channel}}
:#* self chat (prims can't hear themselves)
:#* distance/[[llRegionSay|RegionSay]]
:#* {{LSLP|id}}
:#* {{LSLP|name}}
:#* {{LSLP|msg}}
:# If a {{LSLP|msg}} is found then a [[listen]] [[event]] is added to the [[event]] queue.
:
:The {{LSLP|id}}/{{LSLP|name}}/{{LSLP|msg}} checks only happen at all if those are specified of course.
:
:So, the most efficient communication method is [[llRegionSay]] on a rarely used {{LSLP|channel}}.
:Nowadays, [[llRegionSayTo]] is to be preferred, where appropriate.
*The integer returned can be assigned to a variable (then called a handle) and used to control the listen via [[llListenRemove]] or [[llListenControl]]. These handles are assigned sequentially starting at <tt>+1</tt> through to <tt>+2,147,483,647</tt>, going beyond which, according to [[User:Simon Linden|Simon Linden]], will roll the returned integer over to <tt>−2,147,483,648</tt>, when positive incrementation resumes. If an [[llListen]] is repeated with the exact same filters as a currently active listener, then the same handle number is returned. If an [[llListen|llListen's]] filters do not match any currently active listener, then the next handle in sequence is allocated (it will not re-allocate a recently removed handle).
*If you are using multiple listens in one script, each listen can be assigned its own handle with which to control it.
|caveats=*On [[state]] change or [[llResetScript|script reset]] all listens are removed automatically.
**A [[state]] change can be used as a shortcut to releasing listens.
*Only 65 listens can simultaneously be open in any single script.
**If this number is exceeded ''Script run-time error'' and ''Too Many Listens'' errors occur.
*For some time the official SL viewer and several third party viewers can use negative channels from the chat bar directly just as any other non-zero channel. Formerly, the standard SL viewer could only send chat on negative channels through [[llDialog]] or [[llTextBox]] responses, meaning negative channels were best suited for applications that did not require direct avatar chat.
* Messages sent on positive and negative channels is truncated to 1024 bytes. Chat on positive channels is truncated to 1023 bytes. Chat on negative channels is truncated to 254 bytes.
*Once a [[listen]] is registered its filters cannot be updated, if the listen is registered to [[llGetOwner]], the listen will remain registered to the old owner upon owner change.
**[[CHANGED_OWNER|Owner change]] can be detected with the [[changed]] event.
**To work around this the old listen will need to be closed and a new one opened for the new owner.
*A prim cannot hear/listen to chat it generates. It can, however, hear a linked prim.
**Chat indirectly generated (as a result of [[llDialog]], [[llTextBox]] or from a [[Link|linked prim]]) can be heard if in range.
|examples=
Trivial example to listen to any chat from the object owner and respond once.
{{{!}} class="sortable" width="100%" {{Prettytable}}
{{!}}- {{Hl2}}
! '''Single listen handle'''
{{!}}-
{{!!}}<source lang="lsl2">
// Says beep to owner the first time owner says something in main chat
// and then stops listening

integer listenHandle;

remove_listen_handle()
{
llListenRemove(listenHandle);
}

default
{
state_entry()
{
// Change the channel number to a positive integer
// to listen for '/5 hello' style of chat.

// target only the owner's chat on channel 0 (PUBLIC_CHANNEL)
listenHandle = llListen(0, "", llGetOwner(), "");
}

listen(integer channel, string name, key id, string message)
{
// we filtered to only listen on channel 0
// to the owner's chat in the llListen call above

llOwnerSay("beep");

// stop listening until script is reset
remove_listen_handle();
}

on_rez(integer start_param)
{
llResetScript();
}

changed(integer change)
{
if (change & CHANGED_OWNER)
{
llResetScript();
}
}
}
</source>
{{!}}}

{{{!}} class="sortable" width="100%" {{Prettytable}}
{{!}}- {{Hl2}}
! '''Two listen handles'''
{{!}}-
{{!!}}<source lang="lsl2">
// Opens two listen handles upon touch_start and
// stops listening whenever something heard passes either filter

integer listenHandle_a;
integer listenHandle_b;

remove_listen_handles()
{
llListenRemove(listenHandle_a);
llListenRemove(listenHandle_b);
}

default
{
touch_start(integer num_detected)
{
key id = llDetectedKey(0);
string name = llDetectedName(0);

listenHandle_a = llListen(5, "", id, "");
listenHandle_b = llListen(6, "", NULL_KEY, "");

llSay(0, "Listening now to '" + name + "' on channel 5.");
llSay(0, "Listening now to anybody/anything on channel 6.");
}

listen(integer channel, string name, key id, string message)
{
if (channel == 5)
llSay(0, name + " said: '/5 " + message + "'");

if (channel == 6)
llSay(0, name + " said: '/6 " + message + "'");

remove_listen_handles();
}
}
</source>
{{!}}}
|cat1=Communications
|cat2=Chat
|cat3=Legacy Name/As A Parameter
|cat4=Error
}}

LlListen

2020-11-12T00:32:13Z

Phate Shepherd:

{{LSL_Function
|inject-2={{LSL_Function/uuid|id|pd=filter for specific}}{{LSL Function/chat|channel|msg|input=*|pd=filter for specific}}{{Issues/SVC-3170}}{{Issues/SVC-92}}{{Issues/BUG-3291}}
|func=llListen
|sort=Listen
|func_id=25|func_sleep=0.0|func_energy=10.0
|return_type=integer
|return_subtype=handle
|return_text=that can be used to [[llListenControl|deactivate]] or [[llListenRemove|remove]] the listen.
|p1_type=integer|p1_name=channel|p1_desc= (-2147483648 through 2147483647)|p1_hover= (-2147483648 through 2147483647)
|p2_type=string|p2_name=name|p2_desc=filter for specific prim name or avatar {{LSLGC|Avatar/Name|legacy name}}
|p2_hover=filter for specific prim name or avatar legacy name
|p3_type=key|p3_name=id
|p4_type=string|p4_name=msg
|func_desc=Sets a [http://foldoc.org/index.cgi?query=handle handle] for {{LSLP|msg}} on {{LSLP|channel}} from {{LSLP|name}} and {{LSLP|id}}.
|func_footnote=If {{LSLP|msg}}, {{LSLP|name}} or {{LSLP|id}} are blank (i.e. <code>""</code>) they are not used to filter incoming messages.
If {{LSLP|id}} is an invalid key or assigned the value [[NULL_KEY]], it is considered blank as well. 
|spec=For the [[listen]] [[event]] to be triggered it must first match the criteria set forth by the filters; only when all the criteria have been met is a listen event generated. First the message must have been transmitted on {{LSLP|channel}}. If {{LSLP|id}} is both a [[key#valid|valid]] key and not a [[key#null key|null]] key then the speaker's key must be equivalent{{Footnote|In general terms this means the matching for {{LSLP|id}} is not case sensitive. See [[key#equivalency]] for details on key equivalency.|In general terms this means the matching for id is not case sensitive.}} to {{LSLP|id}}. If {{LSLP|name}} is set then the speaker's {{LSLGC|Avatar/Name|legacy name}} must match {{LSLP|name}} exactly (case sensitive). If {{LSLP|msg}} is set then the spoken message must match {{LSLP|msg}} exactly (case sensitive).
|also_functions={{LSL DefineRow||[[llListenRemove]]|Removes a listen}}
{{LSL DefineRow||[[llListenControl]]|Enables/Disables a listen}}
{{LSL DefineRow||[[llWhisper]]|Sends chat limited to 10 meters}}
{{LSL DefineRow||[[llSay]]|Sends chat limited to 20 meters}}
{{LSL DefineRow||[[llShout]]|Sends chat limited to 100 meters}}
{{LSL DefineRow||[[llRegionSay]]|Sends chat limited current sim}}
{{LSL DefineRow||[[llRegionSayTo]]|Sends chat region wide to a specific avatar, or their attachments, or to a rezzed object of known UUID}}
|also_events={{LSL DefineRow||[[listen]]|}}
|also_tests
|also_articles
|haiku=
{{Haiku|Choose not much to say|Someone might overhear it|Blab no big secrets}}
|notes=*Avoid channel zero (PUBLIC_CHANNEL) and set {{LSLP|name}} or {{LSLP|id}} where possible to avoid lag. <code>llListen(0, "", NULL_KEY,"")</code> can be laggy as it listens to all chat from everyone in chat range and so should be avoided.

*In November 2007, [[User:Kelly_Linden|Kelly Linden]] offered [https://lists.secondlife.com/pipermail/secondlifescripters/2007-November/001993.html this explanation] to help scripters plan listeners more efficiently:
:#Chat that is said gets added to a history.
:#A script that is running and has a [[listen]] [[event]] will ask the history for a chat message during its slice of run time.
:# When the script asks the history for a chat message the checks are done in this order:
:#* {{LSLP|channel}}
:#* self chat (prims can't hear themselves)
:#* distance/[[llRegionSay|RegionSay]]
:#* {{LSLP|id}}
:#* {{LSLP|name}}
:#* {{LSLP|msg}}
:# If a {{LSLP|msg}} is found then a [[listen]] [[event]] is added to the [[event]] queue.
:
:The {{LSLP|id}}/{{LSLP|name}}/{{LSLP|msg}} checks only happen at all if those are specified of course.
:
:So, the most efficient communication method is [[llRegionSay]] on a rarely used {{LSLP|channel}}.
:Nowadays, [[llRegionSayTo]] is to be preferred, where appropriate.
*The integer returned can be assigned to a variable (then called a handle) and used to control the listen via [[llListenRemove]] or [[llListenControl]]. These handles are assigned sequentially starting at <tt>+1</tt> through to <tt>+2,147,483,647</tt>, going beyond which, according to [[User:Simon Linden|Simon Linden]], will roll the returned integer over to <tt>−2,147,483,648</tt>, when positive incrementation resumes. If an [[llListen]] is repeated with the exact same filters as a currently active listener, then the same handle number is returned. If an [[llListen|llListen's]] filters do not match any currently active listener, then the next handle in sequence is allocated (it will not re-allocate a recently removed handle).
*If you are using multiple listens in one script, each listen can be assigned its own handle with which to control it.
|caveats=*On [[state]] change or [[llResetScript|script reset]] all listens are removed automatically.
**A [[state]] change can be used as a shortcut to releasing listens.
*Only 65 listens can simultaneously be open in any single script.
**If this number is exceeded ''Script run-time error'' and ''Too Many Listens'' errors occur.
*For some time the official SL viewer and several third party viewers can use negative channels from the chat bar directly just as any other non-zero channel. Formerly, the standard SL viewer could only send chat on negative channels through [[llDialog]] or [[llTextBox]] responses, meaning negative channels were best suited for applications that did not require direct avatar chat.
* Chat on positive and negative channels is truncated to 1024 bytes. Public channel 0 chat is truncated to 1023 bytes.
*Once a [[listen]] is registered its filters cannot be updated, if the listen is registered to [[llGetOwner]], the listen will remain registered to the old owner upon owner change.
**[[CHANGED_OWNER|Owner change]] can be detected with the [[changed]] event.
**To work around this the old listen will need to be closed and a new one opened for the new owner.
*A prim cannot hear/listen to chat it generates. It can, however, hear a linked prim.
**Chat indirectly generated (as a result of [[llDialog]], [[llTextBox]] or from a [[Link|linked prim]]) can be heard if in range.
|examples=
Trivial example to listen to any chat from the object owner and respond once.
{{{!}} class="sortable" width="100%" {{Prettytable}}
{{!}}- {{Hl2}}
! '''Single listen handle'''
{{!}}-
{{!!}}<source lang="lsl2">
// Says beep to owner the first time owner says something in main chat
// and then stops listening

integer listenHandle;

remove_listen_handle()
{
llListenRemove(listenHandle);
}

default
{
state_entry()
{
// Change the channel number to a positive integer
// to listen for '/5 hello' style of chat.

// target only the owner's chat on channel 0 (PUBLIC_CHANNEL)
listenHandle = llListen(0, "", llGetOwner(), "");
}

listen(integer channel, string name, key id, string message)
{
// we filtered to only listen on channel 0
// to the owner's chat in the llListen call above

llOwnerSay("beep");

// stop listening until script is reset
remove_listen_handle();
}

on_rez(integer start_param)
{
llResetScript();
}

changed(integer change)
{
if (change & CHANGED_OWNER)
{
llResetScript();
}
}
}
</source>
{{!}}}

{{{!}} class="sortable" width="100%" {{Prettytable}}
{{!}}- {{Hl2}}
! '''Two listen handles'''
{{!}}-
{{!!}}<source lang="lsl2">
// Opens two listen handles upon touch_start and
// stops listening whenever something heard passes either filter

integer listenHandle_a;
integer listenHandle_b;

remove_listen_handles()
{
llListenRemove(listenHandle_a);
llListenRemove(listenHandle_b);
}

default
{
touch_start(integer num_detected)
{
key id = llDetectedKey(0);
string name = llDetectedName(0);

listenHandle_a = llListen(5, "", id, "");
listenHandle_b = llListen(6, "", NULL_KEY, "");

llSay(0, "Listening now to '" + name + "' on channel 5.");
llSay(0, "Listening now to anybody/anything on channel 6.");
}

listen(integer channel, string name, key id, string message)
{
if (channel == 5)
llSay(0, name + " said: '/5 " + message + "'");

if (channel == 6)
llSay(0, name + " said: '/6 " + message + "'");

remove_listen_handles();
}
}
</source>
{{!}}}
|cat1=Communications
|cat2=Chat
|cat3=Legacy Name/As A Parameter
|cat4=Error
}}

HexText

2020-11-03T20:50:09Z

Phate Shepherd: Undo revision 1209701 by Phate Shepherd (talk)

== About ==

[[File:HexText_Sample_Display.png]]

HexText is an LSL script to display Unicode text on 8 faced prims within Second Life. Supported is included for Japanese/Chinese, as well as many other languages and symbols. It is not all-inclusive. There are some code pages that are missing. It does cover the majority of characters that avatars use in Unicode enhanced display names.

There are two display scripts. One is optimized for general usage, the other is optimized for Japanese/Chinese.

The primary font used is Google's Noto Monospace (Bold & Regular), supplemented with other open source or public domain fonts for code pages not covered by Noto.

The character set is broken up into ~113 individual textures for each supported Unicode code page, covering roughly 28,000 characters. Each texture is a 16 x 16 matrix of characters. To minimize texture memory usage, the majority of textures are rendered at 512 x 256 pixels. Kanji is rendered at 512 x 384 which gets reduced to 512 x 256 at upload. As the textures are 512 x 256, it takes 8 of them to equal the amount of GPU texture memory used by a single 1024 x 1024 texture. I have found that unless you are displaying Kanji, it is rare to use more memory than 2 - 1024 x 1024 textures.

== Acknowledgments ==

Thanks go to Ochi Wolfe for his excellent [[FURWARE_text]] display sytem and documentation. Without his, and his contributors efforts, HexText would have been significantly more difficult to create.

HexText is released under the MIT license.

HexText uses a subset of the [[FURWARE_text/Reference]] command set. HexText does not support virtual text boxes, inline styles or touch queries.

HexText can use displays set up by the [[FURWARE_text/Tutorial#Creating_displays]], however it can only use the 8 faced prim displays. HexText uses display prims with the same description format used by FURWARE text. HexText only supports a single display set per linkset, unlike FURWARE text that can handle multiple displays per linkset.

The HexText texture set was created with [[FURWARE_text/TextureCreator]].

Use of both HexText and the FURWARE text scripts in the same linkset is not recommended.

Although it is technically possible to combine the FURWARE text engine, and HexText to create a Unicode display system with the features of both, I was concerned that it would not fit in a single script, and would therefore suffer performance issues.

== Setup ==

The following was taken from the FURWARE text manual, edited to remove limitations imposed by HexText. All credit for FURWARE text tools to Ochi Wolfe and his contributors. Hexadeci Mole is only responsible for the alternative HexText Unicode display script and its documentation.

=== Creating displays ===

HexText uses displays created with the FURWARE text display creator available here: https://marketplace.secondlife.com/p/FURWARE-text/141379

You may (and should) use the "'''FURWARE display creator'''" to have a perfectly aligned grid of display prims automatically created for you. Every prim will be automatically assigned a special object name that is used internally by the text script so that it knows how to order them correctly, independently of the link order.

Creating a display is simple:

* Rez the display creator on a parcel where you have sufficient permissions.
* Touch the creator object. A dialog appears where you can set some parameters of the new display:
** A '''name''' for the display. You will use this name to identify which display you wish to manipulate when using multiple displays within one linkset.
** The number of '''rows and columns''' of the display (the columns are counted in prims here, not in characters).
** The number of '''faces per prim'''. There are mesh prims from 1 to 8 faces available. HexText can only use the 8 face display prims.
* When you're happy with the settings, click "Create" to start rezzing the prims. Link them to your creation as appropriate. (I would not recommend that any display prim be link #1 in a linkset)

=== Setup and initialization ===

When you have created your display and linked it together with your creation, put '''a single copy''' of the HexText Script (listed below) into the linkset instead of the FURWARE text script. The script does '''not''' have to be in the root prim.

'''Important hint:'''

You may wish to send some initial commands to the text script as soon as its initialization is done. A reset of the text script may happen in a number of cases:

* The script was just put into the object.
* The object in which the script resides was shift-copied.
* The linkset has changed (then the script needs to search for display prims again).
* The script was reset manually (for instance using the "fw_reset" command).

In order to know when exactly the script is ready to take commands, it sends a link message to the whole set with the "id" parameter set to "fw_ready". It is '''good practice''' to watch for these messages and send your initialization commands when receiving this message. Your code could look something like this:

<source lang="lsl2">
link_message(integer sender, integer num, string str, key id) {
if (id == "fw_ready") {
// Set your default color, alignment, wrapping, trim, etc.
llMessageLinked(sender, 0, "c=red;a=center;w=word", "fw_conf");
// If your default display is not blank, send the default text
llMessageLinked(sender, 0, "Default text", "fw_data");

// ...
}
}
</source>

=== LSL Scripts ===

There are two variants of HexText. The generic version allocates one prim face for each character. The 2XKanji version allocates 2 faces for Kanji/Katakana. This makes C/J/K characters easier to read, but the script is a little more convoluted. Oddly, performance of the 2XKanji version sometimes surpasses the Generic version. Only use one of the scripts below in your linkset. Do not use the FURWARE text script in the same linkset that one of these scripts occupy.

* Generic Script (LSL Mono): [[HexText/HexText_Generic]]
* 2XKanji Script (LSL Mono): [[HexText/HexText_2XKanji]]

== Reference Manual ==

Commands supported in HexText (a subset of the FURWARE text command set.)

=== Commands ===

The following commands can be issued from other scripts in your linkset to control HexText.
==== fw_data ====

Display a string on the screen. The entire screen is overwritten with the text message. If you wish to only overwrite a portion of the display, consider fw_direct.

<source lang="lsl2">
llMessageLinked(LINK_SET, 0, "Some text to draw.", "fw_data");
</source>

==== fw_direct ====

This command is not supported by FURWARE text. It is unique to HexText to display text at specific display coordinates. It does not erase the display when called, instead, it overwrites existing characters in the display. Trim is ignored with fw_direct.

<source lang="lsl2">
llMessageLinked(LINK_SET, 0, "Some text to draw.", "fw_direct:10:2");
</source>

Display the string "Some text to draw." starting at the 11th column, 3rd row (Column/Row numbering starts at 0.)

==== fw_conf & fw_defaultconf ====

Sets the global style preference for the display. Unlike FURWARE text, fw_conf is treated the same as fw_defaultconf.

<source lang="lsl2">
llMessageLinked(LINK_SET, 0, "c=red; a=center", "fw_conf");
llMessageLinked(LINK_SET, 0, "c=red; a=center", "fw_defaultconf");
</source>

==== fw_notify ====

Enable or disable link message notifications when the script has completed rendering. Off by default.

<source lang="lsl2">
llMessageLinked(LINK_SET, 0, "on", "fw_notify");
llMessageLinked(LINK_SET, 0, "off", "fw_notify");
</source>

A link message will be sent to the linkset after rendering is complete with the key value of "fw_done"

==== fw_memory ====

Tells the owner how much memory is available.

<source lang="lsl2">
llMessageLinked(LINK_SET, 0, "", "fw_memory");
</source>

==== fw_reset ====

Performs a full reset on the text script.

<source lang="lsl2">
llMessageLinked(LINK_SET, 0, "", "fw_reset");
</source>

A link message will be sent to the linkset after reset is complete with the key value of "fw_ready"

=== Style settings ===

Text styles and format settings are specified using special strings. They are used for global settings ("fw_conf").

A single setting is given as a '''key=value''' pair, for example '''c=red'''.

Multiple settings are separated by "''';'''", for example '''c=red; a=center; w=none'''.

In the following table: ''Italic'' = Default

{|{{Prettytable}}
! Setting
! Key
! Values
! Description
|-
| Font color
| c
| R,G,B
| Font color as red, green, blue (each in range 0.0-1.0)
|-
|
|
| R,G,B,A
| Font color as red, green, blue, alpha (each in range 0.0-1.0)
|-
|
|
| rand
| Random color (with alpha = 1)
|-
|
|
| (predefined)
| Predefined color, see table below (default is White)
|-
| Alignment
| a
| ''left''
| Alignment left
|-
|
|
| center
| Alignment centered
|-
|
|
| right
| Alignment right
|-
| Wrapping
| w
| ''word''
| Wrap after words, if possible
|-
|
|
| char
| Wrap at any position
|-
|
|
| none
| No wrapping; cuts overlong lines
|-
| Trimming
| t
| ''on''
| Trims whitespace from beginning and end of lines
|-
|
|
| off
| Keeps whitespace (except with wrap=word)
|-
| Force refresh
| force
| on
| Enables forced refresh of all faces (disables optimizations!)
|-
|
|
| ''off''
| Disables forced refresh of all faces (enables optimizations)
|}

=== Predefined colors ===

You may use the following names in place of color vectors in styles.

<table border="0" cellspacing="4" cellpadding="8" style="border:black solid 1px;">
<tr>
<td style="background:#FF0000; color:black; text-align:center;">red</td>
<td style="background:#00FF00; color:black; text-align:center;">green</td>
<td style="background:#0000FF; color:white; text-align:center;">blue</td>
<td style="background:#00FFFF; color:black; text-align:center;">cyan</td>
<td style="background:#FF00FF; color:black; text-align:center;">magenta</td>
<td style="background:#FFFF00; color:black; text-align:center;">yellow</td>
<td style="background:#FFFFFF; color:black; text-align:center;">white</td>
<td style="background:#C0C0C0; color:white; text-align:center;">silver</td>
</tr>
<tr>
<td style="background:#800000; color:white; text-align:center;">darkred</td>
<td style="background:#008000; color:white; text-align:center;">darkgreen</td>
<td style="background:#000080; color:white; text-align:center;">darkblue</td>
<td style="background:#008080; color:white; text-align:center;">darkcyan</td>
<td style="background:#800080; color:white; text-align:center;">darkmagenta</td>
<td style="background:#808000; color:white; text-align:center;">darkyellow</td>
<td style="background:#000000; color:white; text-align:center;">black</td>
<td style="background:#808080; color:white; text-align:center;">gray</td>
</tr>
</table>

== Bugs ==
Probably a lot. Let Hexadeci Mole know.

HexText

2020-11-03T20:49:08Z

Phate Shepherd: /* Style settings */

== About ==

[[File:HexText_Sample_Display.png]]

HexText is an LSL script to display Unicode text on 8 faced prims within Second Life. Supported is included for Japanese/Chinese, as well as many other languages and symbols. It is not all-inclusive. There are some code pages that are missing. It does cover the majority of characters that avatars use in Unicode enhanced display names.

There are two display scripts. One is optimized for general usage, the other is optimized for Japanese/Chinese.

The primary font used is Google's Noto Monospace (Bold & Regular), supplemented with other open source or public domain fonts for code pages not covered by Noto.

The character set is broken up into ~113 individual textures for each supported Unicode code page, covering roughly 28,000 characters. Each texture is a 16 x 16 matrix of characters. To minimize texture memory usage, the majority of textures are rendered at 512 x 256 pixels. Kanji is rendered at 512 x 384 which gets reduced to 512 x 256 at upload. As the textures are 512 x 256, it takes 8 of them to equal the amount of GPU texture memory used by a single 1024 x 1024 texture. I have found that unless you are displaying Kanji, it is rare to use more memory than 2 - 1024 x 1024 textures.

== Acknowledgments ==

Thanks go to Ochi Wolfe for his excellent [[FURWARE_text]] display sytem and documentation. Without his, and his contributors efforts, HexText would have been significantly more difficult to create.

HexText is released under the MIT license.

HexText uses a subset of the [[FURWARE_text/Reference]] command set. HexText does not support virtual text boxes, inline styles or touch queries.

HexText can use displays set up by the [[FURWARE_text/Tutorial#Creating_displays]], however it can only use the 8 faced prim displays. HexText uses display prims with the same description format used by FURWARE text. HexText only supports a single display set per linkset, unlike FURWARE text that can handle multiple displays per linkset.

The HexText texture set was created with [[FURWARE_text/TextureCreator]].

Use of both HexText and the FURWARE text scripts in the same linkset is not recommended.

Although it is technically possible to combine the FURWARE text engine, and HexText to create a Unicode display system with the features of both, I was concerned that it would not fit in a single script, and would therefore suffer performance issues.

== Setup ==

The following was taken from the FURWARE text manual, edited to remove limitations imposed by HexText. All credit for FURWARE text tools to Ochi Wolfe and his contributors. Hexadeci Mole is only responsible for the alternative HexText Unicode display script and its documentation.

=== Creating displays ===

HexText uses displays created with the FURWARE text display creator available here: https://marketplace.secondlife.com/p/FURWARE-text/141379

You may (and should) use the "'''FURWARE display creator'''" to have a perfectly aligned grid of display prims automatically created for you. Every prim will be automatically assigned a special object name that is used internally by the text script so that it knows how to order them correctly, independently of the link order.

Creating a display is simple:

* Rez the display creator on a parcel where you have sufficient permissions.
* Touch the creator object. A dialog appears where you can set some parameters of the new display:
** A '''name''' for the display. You will use this name to identify which display you wish to manipulate when using multiple displays within one linkset.
** The number of '''rows and columns''' of the display (the columns are counted in prims here, not in characters).
** The number of '''faces per prim'''. There are mesh prims from 1 to 8 faces available. HexText can only use the 8 face display prims.
* When you're happy with the settings, click "Create" to start rezzing the prims. Link them to your creation as appropriate. (I would not recommend that any display prim be link #1 in a linkset)

=== Setup and initialization ===

When you have created your display and linked it together with your creation, put '''a single copy''' of the HexText Script (listed below) into the linkset instead of the FURWARE text script. The script does '''not''' have to be in the root prim.

'''Important hint:'''

You may wish to send some initial commands to the text script as soon as its initialization is done. A reset of the text script may happen in a number of cases:

* The script was just put into the object.
* The object in which the script resides was shift-copied.
* The linkset has changed (then the script needs to search for display prims again).
* The script was reset manually (for instance using the "fw_reset" command).

In order to know when exactly the script is ready to take commands, it sends a link message to the whole set with the "id" parameter set to "fw_ready". It is '''good practice''' to watch for these messages and send your initialization commands when receiving this message. Your code could look something like this:

<source lang="lsl2">
link_message(integer sender, integer num, string str, key id) {
if (id == "fw_ready") {
// Set your default color, alignment, wrapping, trim, etc.
llMessageLinked(sender, 0, "c=red;a=center;w=word", "fw_conf");
// If your default display is not blank, send the default text
llMessageLinked(sender, 0, "Default text", "fw_data");

// ...
}
}
</source>

=== LSL Scripts ===

There are two variants of HexText. The generic version allocates one prim face for each character. The 2XKanji version allocates 2 faces for Kanji/Katakana. This makes C/J/K characters easier to read, but the script is a little more convoluted. Oddly, performance of the 2XKanji version sometimes surpasses the Generic version. Only use one of the scripts below in your linkset. Do not use the FURWARE text script in the same linkset that one of these scripts occupy.

* Generic Script (LSL Mono): [[HexText/HexText_Generic]]
* 2XKanji Script (LSL Mono): [[HexText/HexText_2XKanji]]

== Reference Manual ==

Commands supported in HexText (a subset of the FURWARE text command set.)

=== Commands ===

The following commands can be issued from other scripts in your linkset to control HexText.
==== fw_data ====

Display a string on the screen. The entire screen is overwritten with the text message. If you wish to only overwrite a portion of the display, consider fw_direct.

<source lang="lsl2">
llMessageLinked(LINK_SET, 0, "Some text to draw.", "fw_data");
</source>

==== fw_direct ====

This command is not supported by FURWARE text. It is unique to HexText to display text at specific display coordinates. It does not erase the display when called, instead, it overwrites existing characters in the display. Trim is ignored with fw_direct.

<source lang="lsl2">
llMessageLinked(LINK_SET, 0, "Some text to draw.", "fw_direct:10:2");
</source>

Display the string "Some text to draw." starting at the 11th column, 3rd row (Column/Row numbering starts at 0.)

==== fw_conf & fw_defaultconf ====

Sets the global style preference for the display. Unlike FURWARE text, fw_conf is treated the same as fw_defaultconf.

<source lang="lsl2">
llMessageLinked(LINK_SET, 0, "c=red; a=center", "fw_conf");
llMessageLinked(LINK_SET, 0, "c=red; a=center", "fw_defaultconf");
</source>

==== fw_notify ====

Enable or disable link message notifications when the script has completed rendering. Off by default.

<source lang="lsl2">
llMessageLinked(LINK_SET, 0, "on", "fw_notify");
llMessageLinked(LINK_SET, 0, "off", "fw_notify");
</source>

A link message will be sent to the linkset after rendering is complete with the key value of "fw_done"

==== fw_memory ====

Tells the owner how much memory is available.

<source lang="lsl2">
llMessageLinked(LINK_SET, 0, "", "fw_memory");
</source>

==== fw_reset ====

Performs a full reset on the text script.

<source lang="lsl2">
llMessageLinked(LINK_SET, 0, "", "fw_reset");
</source>

A link message will be sent to the linkset after reset is complete with the key value of "fw_ready"

=== Style settings ===

Text styles and format settings are specified using special strings. They are used for global settings ("fw_conf").

A single setting is given as a '''key=value''' pair, for example '''c=red'''.

Multiple settings are separated by "''';'''", for example '''c=red; a=center; w=none'''.

In the following table: '''Bold''' = Default

{|{{Prettytable}}
! Setting
! Key
! Values
! Description
|-
| Font color
| c
| R,G,B
| Font color as red, green, blue (each in range 0.0-1.0)
|-
|
|
| R,G,B,A
| Font color as red, green, blue, alpha (each in range 0.0-1.0)
|-
|
|
| rand
| Random color (with alpha = 1)
|-
|
|
| (predefined)
| Predefined color, see table below (default is White)
|-
| Alignment
| a
| '''left'''
| Alignment left
|-
|
|
| center
| Alignment centered
|-
|
|
| right
| Alignment right
|-
| Wrapping
| w
| '''word'''
| Wrap after words, if possible
|-
|
|
| char
| Wrap at any position
|-
|
|
| none
| No wrapping; cuts overlong lines
|-
| Trimming
| t
| '''on'''
| Trims whitespace from beginning and end of lines
|-
|
|
| off
| Keeps whitespace (except with wrap=word)
|-
| Force refresh
| force
| on
| Enables forced refresh of all faces (disables optimizations!)
|-
|
|
| '''off'''
| Disables forced refresh of all faces (enables optimizations)
|}

=== Predefined colors ===

You may use the following names in place of color vectors in styles.

<table border="0" cellspacing="4" cellpadding="8" style="border:black solid 1px;">
<tr>
<td style="background:#FF0000; color:black; text-align:center;">red</td>
<td style="background:#00FF00; color:black; text-align:center;">green</td>
<td style="background:#0000FF; color:white; text-align:center;">blue</td>
<td style="background:#00FFFF; color:black; text-align:center;">cyan</td>
<td style="background:#FF00FF; color:black; text-align:center;">magenta</td>
<td style="background:#FFFF00; color:black; text-align:center;">yellow</td>
<td style="background:#FFFFFF; color:black; text-align:center;">white</td>
<td style="background:#C0C0C0; color:white; text-align:center;">silver</td>
</tr>
<tr>
<td style="background:#800000; color:white; text-align:center;">darkred</td>
<td style="background:#008000; color:white; text-align:center;">darkgreen</td>
<td style="background:#000080; color:white; text-align:center;">darkblue</td>
<td style="background:#008080; color:white; text-align:center;">darkcyan</td>
<td style="background:#800080; color:white; text-align:center;">darkmagenta</td>
<td style="background:#808000; color:white; text-align:center;">darkyellow</td>
<td style="background:#000000; color:white; text-align:center;">black</td>
<td style="background:#808080; color:white; text-align:center;">gray</td>
</tr>
</table>

== Bugs ==
Probably a lot. Let Hexadeci Mole know.

User talk:Strife Onizuka

2012-09-28T19:58:13Z

Phate Shepherd:

{{:User:Zai_Lynch/Award}}You found my talk page... Find old discussions take a look at the archives: [[User:Strife_Onizuka/Talkpage_Archive_01|1]] [[User:Strife_Onizuka/Talkpage_Archive_02|2]]

== JIRA issues on LSL function pages ==

Okay, as I've made no headway deciphering your templates (not that I'm familiar in the least with the more complex wiki functions in the first place...) I decided just to cut my losses and ask! Basically I was wondering if there's a reason why [[Template:LSL_Generic/Issues]] doesn't appear to list all issues, but instead seems to just list bugs only in the same way as [[Template:LSL_Generic/Caveats]]?

I just think it'd be nice if function pages would also summarise popular proposals relating to them in the deep notes section, which is what I believed was intended but it doesn't appear to do this right now.

For example, if you go to the [[LlStartAnimation]] page, in the deep notes you'll notice that there are zero issues listed, however, clicking the "Search JIRA for related Issues" link returns quite a few. It might be nice to see the deep notes tweaked to display these, but perhaps with a limit on how many are shown (though llStartAnimation is a fairly popular one to see JIRA issues for and only has 17 issues listed). Anyway, just though I'd ask/request, please poke my talk page if you respond to be sure I remember and look! --[[User:Haravikk Mistral|Haravikk Mistral]] 15:26, 12 September 2010 (UTC)

:The template is not automatic. Take for example [[llBreakLink]], it lists a single issue in the article, it does this by including the template [[Template:Issues/SVC-3510]]. There are many stub templates like [[Template:Issues/SVC-3510]] that work this way, they contain the information about the issue and pass it along to a template that does the heavy lifting. The value of this method is that a single template exists for the Issue and if the issue is sited on multiple pages, they can all be quickly updated by modifying the template. From an organizational standpoint, it also makes it possible to see what all pertains to a particular issue.

:The thing is, if you want all the issues on the wiki, they need to be imported to the wiki, and regularly updated as changes are made... but that could all be done with a bot. Wonder if [[User:Gigs Taggart|Gigs]] could be enticed to incorporate it into [http://www.sljirastats.com SLJiraStats]?

:The goal of the Deep Notes: Issues section was to contain dead bugs and interesting feature suggestions. I never intended it to contain all issues pertaining to a feature. We don't add any value by duplicated the JIRA search engine results; the value we can add is by filtering them. Some of the bugs aren't bugs, and some of the feature suggestions are unworkable; I don't think these should be given screen space. Considering the resources required to manually include and update the issues, triage has to happen.

:Unfortunately I do not have the free time to work on this, work and other responsibilities eat all my time. *wonders just how true that is* -- '''[[User:Strife_Onizuka|Strife]]''' ([[User talk:Strife_Onizuka|talk]]|[[Special:Contributions/Strife_Onizuka|contribs]]) 03:10, 16 September 2010 (UTC)

::Ah yeah, seems I've completely misunderstood what it was doing! I wasn't thinking to list everything, just an automatic, and hopefully useful summary of say...the top ten bugs and issues? It sounds like way more work than it's likely to be worth though so probably better just to forget about it, unless there's some way to just embed an iframe with a portion of a JIRA search or something similar? But that would probably cause an unacceptable increase in JIRA page requests from people just popping over to look something up. But now I know how it does work I can at least pop useful relevant issues on manually, thanks! -- [[User:Haravikk Mistral|Haravikk Mistral]] 12:36, 18 September 2010 (UTC)

:A related problem, I've tried to add a few top issues of interest to me onto my user page under Key Issues, however, I've tried to create two [[Template:IssueTable]] instances, but they both have the same content, despite the value of #issues being different for both. Is this some peculiarity in using this template more than once? If you could take a look at let me know it'd be handy, as IssueTable doesn't have any documentation =( -- [[User:Haravikk Mistral|Haravikk Mistral]] 11:36, 22 September 2010 (UTC)

::You are hitting one of the caveats/bugs of the new parser engine. I forget how to get around it. I beleive the issue is intermediate caching, and the way around it is to make the template call dynamic or something like that. Without spending a bunch of time debugging the problem, I just don't remember how to work around it. -- '''[[User:Strife_Onizuka|Strife]]''' ([[User talk:Strife_Onizuka|talk]]|[[Special:Contributions/Strife_Onizuka|contribs]]) 14:37, 22 September 2010 (UTC)

::It just struck me what the problem is, it's caching IssueTable. -- '''[[User:Strife_Onizuka|Strife]]''' ([[User talk:Strife_Onizuka|talk]]|[[Special:Contributions/Strife_Onizuka|contribs]]) 18:27, 22 September 2010 (UTC)

:::Aha! The "subst:" keyword seems to be for this (e.g - <code><nowiki>{{subst:User:Haravikk_Mistral/JIRA/Issues/SVC}}</nowiki></code>), as I believe it fetches the pre-processed contents of a page rather than the source. In any event, this works in my case as I created sub-pages for each category, I don't believe it would help for a page with multiple IssueTable instances though, as using subst: for any of them would just create a blank gap, but it solves my problem at least! -- [[User:Haravikk Mistral|Haravikk Mistral]] 11:29, 23 September 2010 (UTC)

== [[Ghost Detector]] ==
Thanks. I discovered that property of [[llKey2Name]] by accident. It's odd because, for instance, [[llDetectedName]] gives a non-empty string for ghosted avatars. -- [[User:Something Something|Something Something]] 05:21, 10 November 2010 (UTC)

== Friendly greetings ==
You seem to have found a "fix" for my horrible script and....messed it up. Please compare my original to yours and do some testing. They are different in the result. I would appreciate you fixing your "fix". Best regards --[[User:Kireji Haiku|Kireji Haiku]] 02:42, 14 December 2010 (UTC)

:I'm sorry you took the edit personally it was not intended that way. The example you contributed is valuable and nontrivial, however examples are held to high standards and it didn't meet them. I was faced with two options: rewriting it or deleting it, I felt it had merit so I rewrote it. My goal as always is to provide the most useful content to our users, and in this case down compatibility needed to be sacrificed. The script as it was designed required every prim to have at least one face have full glow, that didn't sound entirely useful, so I changed it to accept some glow (I notice that I also changed it to require every face have glow... which doesn't sound useful, so I'm going to revert that).
:Examples have one major goal: Be educational, teach good coding practices and problem solving. Here is where the script went awry:
:# Names should be descriptive. The function names were a bit generic but single letter variables are definitely not descriptive, especially when they are globals, they really should describe the purpose they fulfill.
:# Using globals instead of locals & parameters may be efficient, but it degrades readability and adds a new vector for script bugs. This sort of optimization has no place in examples (except in an article on optimization techniques). The situation is made even worse by using non-descriptive variable names.
:# The script contained code that complicated it without aiding readability or improving functionality. Examples need to be streamline, having it meander requires the reader to needlessly keep track of more things.
:# I felt that the functionality provided had too narrow an audience, that by changing how it functioned that it would be more useful to more people. Down compatibility is a secondary consideration for examples, not a primary consideration.

:P.S. I take it you didn't noticed there is a bug in your script: A single prim object with at least one avatar sitting on it could return the wrong result. IMO examples should not be attributed in the script text, it's what the history page is for after all, but I know the community and I don't always agree so I don't fight it. Personally I don't want my name associated with buggy code, so if you really want the script to be 100% compatible I'll have to remove my name and give you all the credit.

:P.S.S. I think we may have different notions of wiki content ownership. When I post content on the wiki, I do so with the full expectation that it will be edited, that it will mutate into something I did not envision, into something I may not entirely agree with. We do not control the content after we have posted it. It's why there is the text below the edit box: "If you don't want your writing to be edited mercilessly and redistributed at will, then don't submit it here." Wiki culture is different. I may own my contributions but I don't control their fate. They are my children, being changed and influenced by the people around them, being made stronger in the process. But I digress

:P.S.S.S. In the future if you want to convince someone they should do something, don't insult them first, it's counter productive. A better way to approach this situation would have been to say: "I disagree with some of the changes you made, specifically blah blah blah, could you please look into it? I did not appreciate your tone and I am quite insulted." It's a mistake to mix the two messages, people are prone to take offense and not do what you want out of spite. In a situation like this being snarky just isn't productive (though it does blow off a bit of steam which can feel good in the moment). Just FYI, nothing more. -- '''[[User:Strife_Onizuka|Strife]]''' ([[User talk:Strife_Onizuka|talk]]|[[Special:Contributions/Strife_Onizuka|contribs]]) 07:43, 14 December 2010 (UTC)

::I didn't take it personally and was just trying to make you aware of your rewrite not doing the same like my script. Maybe you don't read in-world messages, as I had sent you a message thanking you for your rewrite and trying to point out the differences between the two. The script I had provided would check a link-set on whether or not it has glow. And yes, that would return a false result if avatars sit on it, but I thought nobody would use the script to check if a link-set is glowing while sitting on it, but I might be wrong and should have pointed that out in the description. So I see your point there and support your critique on that. However my script would return "glowing" for a prim if ANY number of faces have SOME glow (not 1.0, as you said it would do). Maybe you now understand my view when I see your rewrite as being more streamlined and easier to read, however you limit the script down in its original ability of detecting glow by forcing it to return positive only with all faces of a prim glowing. Anyway, I'm not up for a fight and to be quite frank just too lazy for it, a builder inside of SL asked me if it's possible to detect whether or not there's a bit of glow on all prims inside a link-set of his build and I just felt like sharing my approach of writing a script for that. If that script doesn't meet wiki standards in terms of streamlining it towards being absolutely foolproof and readable for just about anybody, I'll have to refrain from doing so in future.--[[User:Kireji Haiku|Kireji Haiku]] 18:13, 14 December 2010 (UTC)

:::First I need to apologize, when I wrote my last comment I hadn't carefully reread your script, if I had I would have noticed your use of llCeil, which does as you point out return true for some glow. So my argument on that point is baseless. Between work and other obligations, I had forgotten about that aspect of the script and just went on my memory of what I thought the script was doing. As to fighting, I agree it's a waste of time and effort. However I hope you do continue to contribute to the wiki, every contribution is valuable as they grow the understanding and knowledge base of the community. Standards evolve and the content does as well, content has to be nurtured, given room to grow. Immature content just needs to mature is all; the only time stuff gets deleted is if it's factually inaccurate or needlessly repetitive. If I thought the contribution was trivial and obvious I would have stripped your name from it (attribution on one liners is blatant self ego boosting and makes the wiki look unprofessional). The only reason I attached my name was so that you wouldn't be forced to shoulder the costs of supporting code that you did not write. Please don't take away from this that your contribution was without value, or that I had no respect for it or you.

:::I should mention the reason for my terse comment in the edit was for a simple reason: I couldn't be verbose with the text limits of the field.

:::As to messaging me, all my IMs get sent to an email account I rarely check, I only ever go inworld to keep my accounts active and go to meetings (pretty rare) because my internet connect is total suckage. I had no idea you IMed me; for all correspondence I use the wiki and email.

:::You would be quite ticked at me if I were to describe my scripting habits with regards to code I post. I know I was when I saw people do what I do, but I don't really have the option. It's an ROI equation, should I make possibly buggy contributions or make no contributions at all? I wish I weren't forced to make the choice. If I weren't here doing this who would take up the mantel? Who would look after the templates? It would avoid problems like this maybe but would the community be better off? I honestly don't know but I suspect not.

:::If you're still reading, what changes or improvements would you like to see made to the documentation? An upcoming project is to incorporate collapsible sections into the documentation, I'm just not sure yet how to do so, I could do with some input. I haven't called for input from the community yet because I haven't rolled out the new Constants template yet (which will revolutionize the {{LSLGC|PrimitiveParams}} documentation). Given the potential of collapsible sections we are at a point in time where we should consider redesigning the documentation from the ground up. Maybe a contest? -- '''[[User:Strife_Onizuka|Strife]]''' ([[User talk:Strife_Onizuka|talk]]|[[Special:Contributions/Strife_Onizuka|contribs]]) 22:33, 14 December 2010 (UTC)

:::P.S. Does it work as it did before now? -- '''[[User:Strife_Onizuka|Strife]]''' ([[User talk:Strife_Onizuka|talk]]|[[Special:Contributions/Strife_Onizuka|contribs]]) 23:48, 14 December 2010 (UTC)

::::Hi, no it doesn't. The first problem is your thing with the double exclamation mark, that always returns 1 for me. And the second being you're still stuck with [PRIM_GLOW,ALL_SIDES], you don't do a loop through the sides. I will post a re-do of mine again, if you find a way to do what you wanted to do with the double exclamation mark thing, let me know.[[User:Kireji Haiku|Kireji Haiku]] 21:16, 17 December 2010 (UTC)

:::::<code>!![[llGetLinkNumber]]()</code> returns 1 for multiprim objects or 0 for single prim objects; It's logically equivalent to <code>llGetLinkNumber() != 0</code> however it requires less bytecode to express (you would not be without base to berate me for perpetrating this optimization/shorthand in an example script). You shouldn't need to loop through the sides, by using [[ALL_SIDES]] it should return a list containing the glow values for every side of the prim (not a very useful feature, in most cases uses it's better to loop through the sides). We then feed that list to the list stat function to get the max. I'll see if I can log in later to test it but right now I really need to fix the LSL documentation templates (the wiki upgrade broke at least one template, which in turn broke a lot of the LSL documentation; I'm trying to both find and fix the broken templates; and I don't know the precise cause). -- '''[[User:Strife_Onizuka|Strife]]''' ([[User talk:Strife_Onizuka|talk]]|[[Special:Contributions/Strife_Onizuka|contribs]]) 21:37, 17 December 2010 (UTC)

::::::Fixed it finally, thanks again for the ideas and the input. <code>!![[llGetLinkNumber]]()</code> doesn't seem to work, I know exactly what you're trying to do by writing it that way, but that always returns 1. Have tested it. And your return was a bit too fast to return a result, wouldn't wait until the end. If you can simplify it even further, go ahead. That's as far as I could get.[[User:Kireji Haiku|Kireji Haiku]] 21:12, 23 December 2010 (UTC)

:::::::Is <code>!![[llGetLinkNumber]]</code> returning one for a single prim object with no avatars sitting on it? That is the only time it should return zero. A single prim object with a seated avatar should return one. As to the early exit, once we find a prim with no glow, we can exit without checking the other prims. Logically speaking, we do not need to know precisely what the minimum is, just if it is less than or equal to zero. So instead of calculating the minimum we can exit as soon as we know the minimum is going to be less than or equal to zero. We know it will be less than or equal to zero if we have a value that is zero or less. The code should exit as soon as it knows the answer so as to not waste simulator resources (after all we need to encourage responsible coding). -- '''[[User:Strife_Onizuka|Strife]]''' ([[User talk:Strife_Onizuka|talk]]|[[Special:Contributions/Strife_Onizuka|contribs]]) 05:08, 25 December 2010 (UTC)
::::::::Personally, I would prefer that examples intended to educate and demonstrate functionality NOT have obfuscating optimizations in them, unless the purpose of the example is to demonstrate such. It makes it harder for non-gurus to understand what is going on in the script, thus limiting the "educational value" of the example and obviating the purpose which it was intended. That said, I do believe it is important for people to know about them as well as how/when to use them, but I also believe teaching good programming habits is also valuable. (I don't know if the script in question qualifies as such; just wanted to point this out since it came up as an ancillary issue) [[User:Talarus Luan|Talarus Luan]] 07:35, 15 January 2011 (UTC)

== Help with template issue ==

Hi Strife,
I'm hoping you can help to shed some light on a problem we have just discovered that has started to occur since we redployed the wiki yesterday. The symptom is that SOME pages, e.g. [[LlKey2Name]] display differently when you are not logged in versus logged in. Compare
* Logged in: http://screencast.com/t/e3K85IGni
* Not logged in: http://screencast.com/t/4OwWfihvhi
I ''think'' that this may be happening due to issues around templates, which is why I am contacting you. However, I don't really know the cause. The strange thing is that most other LSL function pages appear to display just fine when you are logged out; so there must be something in that page causing an issue. We would greatly appreciate any help! P.S. Here is the whole list of known issues: [[Second Life Wiki Known Issues]].

Thanks
--[[User:Rand Linden|Rand Linden]] 17:15, 16 December 2010 (UTC)

:I think it was generated before the extensions were installed. I purged the page (?action=purge) and it now renders properly for me (though I did see it the way you described but only when i was not logged in). It's weird. -- '''[[User:Strife_Onizuka|Strife]]''' ([[User talk:Strife_Onizuka|talk]]|[[Special:Contributions/Strife_Onizuka|contribs]]) 21:22, 16 December 2010 (UTC)

::Maybe the cache just needs to be invalidated? -- '''[[User:Strife_Onizuka|Strife]]''' ([[User talk:Strife_Onizuka|talk]]|[[Special:Contributions/Strife_Onizuka|contribs]]) 21:24, 16 December 2010 (UTC)

::Some triangulation: <nowiki>|constants={{LSL Constants/PrimitiveParams|get}}</nowiki> does ''not'' cause trouble on a test copy of llSetLinkPrimitiveParams, <nowiki>|constants={{LSL Constants/PrimitiveParams|set}}</nowiki> triggers the bug. Off to try on simpler stuff to see if there is a consistent pattern of some kind ... --[[User:Cerise Sorbet|Cerise Sorbet]] 21:47, 16 December 2010 (UTC)

::The cache is not invalidating or refreshing. Check the mod date at the bottom of [[http://wiki.secondlife.com/wiki/LlSetLinkPrimitiveParamsFast]] and [[https://wiki.secondlife.com/wiki/LlSetLinkPrimitiveParamsFast]]. They are different. If you go into the history page and look at a previous version it will displays properly because it doesn't have a cached version but if you look at the current version (even with the version number, it does not display properly). Not even action=purge can budge it. A possible explanation is that the PrimitiveParams article is causing it to time out during rebuild. The new version of the template I'm hoping to get done by new year should be more sane and less time consuming (we hope). -- '''[[User:Strife_Onizuka|Strife]]''' ([[User talk:Strife_Onizuka|talk]]|[[Special:Contributions/Strife_Onizuka|contribs]]) 22:00, 16 December 2010 (UTC)

:: I thought it was only cache too but more appears to be going on. [[llKey2Name]] is displaying OK with a pair of Issue templates commented out. --[[User:Cerise Sorbet|Cerise Sorbet]] 22:22, 16 December 2010 (UTC)

:::The time issue I was seeing was caused by me having my account report the times in GMT+5 (which is weird seeing as i'm GMT-5) -- '''[[User:Strife_Onizuka|Strife]]''' ([[User talk:Strife_Onizuka|talk]]|[[Special:Contributions/Strife_Onizuka|contribs]]) 22:31, 16 December 2010 (UTC)

:I've had a thought, I think it might have something to do with how bugs are duplicated (in both Issues and Important Issues). It looks to be the difference between the Get and Set primitive Params functions (Get are too new to have any flag bugs). -- '''[[User:Strife_Onizuka|Strife]]''' ([[User talk:Strife_Onizuka|talk]]|[[Special:Contributions/Strife_Onizuka|contribs]]) 22:42, 16 December 2010 (UTC)

::It's not [[Template:Issues]] that is doing it, it's something about [[Template:Issue]]. I have this terrible feeling it's a problem with how #switch is parsed. When are we getting the new parser function extension? -- '''[[User:Strife_Onizuka|Strife]]''' ([[User talk:Strife_Onizuka|talk]]|[[Special:Contributions/Strife_Onizuka|contribs]]) 22:55, 16 December 2010 (UTC)

:::Oh it's definitely [[Template:Issue]]. I can't access it when logged out. -- '''[[User:Strife_Onizuka|Strife]]''' ([[User talk:Strife_Onizuka|talk]]|[[Special:Contributions/Strife_Onizuka|contribs]]) 22:55, 16 December 2010 (UTC)

::::I've disabled the code that detects if an issue is a bug, which appears to have fixed [[llKey2Name]]. -- '''[[User:Strife_Onizuka|Strife]]''' ([[User talk:Strife_Onizuka|talk]]|[[Special:Contributions/Strife_Onizuka|contribs]]) 23:14, 16 December 2010 (UTC)

: #switch is not the cause, just the trigger. Maybe it's content duplication that is the problem? -- '''[[User:Strife_Onizuka|Strife]]''' ([[User talk:Strife_Onizuka|talk]]|[[Special:Contributions/Strife_Onizuka|contribs]]) 22:28, 17 December 2010 (UTC)

: Mediawiki 1.14 added a |link= option for Image: tags. This would let you skip the imagemap for most uses that don't really need coordinates. --[[User:Cerise Resident|Cerise]] 03:38, 18 December 2010 (UTC)

:: There is a god ^_^ thanks for the tip. I'll deploy it post hast. -- '''[[User:Strife_Onizuka|Strife]]''' ([[User talk:Strife_Onizuka|talk]]|[[Special:Contributions/Strife_Onizuka|contribs]]) 03:40, 18 December 2010 (UTC)

::: Thanks so much for tracking this down, Strife and Cerise! This move/upgrade has certainly been more problematic than we expected.... :-(
:::--[[User:Rand Linden|Rand Linden]] 19:05, 19 December 2010 (UTC)

:::: They always are more problematic than anticipated. I'm sorry I didn't pay more attention to it earlier, I did notice the blanking on the test wiki briefly but not the common factor (since I spend all my time logged in, the first thing I always do when I connect is log in). I spent my time looking at differences between the highlighting. Never thought to look for differences between HTTP & HTTPS. -- '''[[User:Strife_Onizuka|Strife]]''' ([[User talk:Strife_Onizuka|talk]]|[[Special:Contributions/Strife_Onizuka|contribs]]) 19:30, 19 December 2010 (UTC)

== Different versions of UTF-8 libraries ==

Hi Strife, it seems that there are two different versions of both UTF8ToUnicodeInteger() and UnicodeIntegerToUTF8() at [[Combined_Library#Unicode_functions]] and [[UTF-8]]. Maybe those could be moved to a template - or just manually synced as you feel appropriate. --[[User:Opensource Obscure|oobscure]] 03:17, 2 May 2011 (PDT)

There is a good point. Will do. -- '''[[User:Strife_Onizuka|Strife]]''' ([[User talk:Strife_Onizuka|talk]]|[[Special:Contributions/Strife_Onizuka|contribs]]) 09:12, 12 May 2011 (PDT)

== Issues/SCR-137 ==

Sorry for [[Template:Issues/SCR-137]], force of habit since most of the time I'm suggesting new functions that aren't on the wiki, rather than changes to existing ones ;) -- -- '''[[User:Haravikk_Mistral|Haravikk]]''' ([[User_talk:Haravikk_Mistral|talk]]|[[Special:Contributions/Haravikk_Mistral|contribs]]) 01:43, 9 July 2011 (PDT)

:No need to apologize. In my diminished capacity these days (being cut off from SL due to network restrictions for such a long time) there is little I can do besides act as editor, and theoretical scripting. So you gave me something to do. -- '''[[User:Strife_Onizuka|Strife]]''' ([[User talk:Strife_Onizuka|talk]]|[[Special:Contributions/Strife_Onizuka|contribs]]) 09:10, 9 July 2011 (PDT)

== llCastRay Docs ==

Thanks, Strife. Your improvement to the llCastRay docs look great.

[[User:Falcon Linden|Falcon Linden]] 11:57, 1 September 2011 (PDT)

== User Functions ==

Heya Strife,
Could you give me a headsup how the wiki format for Mode=User LSL Functions are meant to be used like?

https://wiki.secondlife.com/wiki/Interpolation/Linear/Float

I'm not sure why I can't get rid off the "Deep Notes" section, which seems sorta empty and useless?

[[User:Nexii Malthus|Nexii Malthus]] 11:48, 17 September 2011 (PDT)

:Sure -- '''[[User:Strife_Onizuka|Strife]]''' ([[User talk:Strife_Onizuka|talk]]|[[Special:Contributions/Strife_Onizuka|contribs]]) 13:36, 18 September 2011 (PDT)

== Video Documentations / Tutorials ==
forgot who the king of confirming stuff on this wiki is, I haven't been an editor for like a year or two if you remember me or not, but I thought I might add video documentations and tutorials on functions that could be confusing on the wikis page, so I guess the question is how should I add the videos, should I add a new category or just put it in the examples category, and if video documentation is a good idea toward you, since you are the #1 editor on this wiki haha, and I know nothing about style D:
----[[File:Uglehsig.png|53px|link=User:Ugleh_Ulrik]]([[User_talk:Ugleh_Ulrik|talk]]) 19:45, 11 October 2011 (PDT)

:I'm tickled that you would consult me but I really have no idea on this one. I think it's a great idea and until we get more of them to get a feel as to how they can be best incorporated into the documentation, they can be included any way you see fit. I might suggested posting the question to the script forums and mailing list (if you do, maybe post a link so I can follow along?). I can imagine putting them in See Also, Examples, Deep Notes, Helpers, Specification (maybe?), Newbie Notes, Notes. I have trouble seeing them in the Summary/Description, Caveats or Constants. Maybe float them on the right (like in [[PRIM_MATERIAL]])? Keep up the good work. ^_^ -- '''[[User:Strife_Onizuka|Strife]]''' ([[User talk:Strife_Onizuka|talk]]|[[Special:Contributions/Strife_Onizuka|contribs]]) 12:21, 12 October 2011 (PDT)

== Hi ==

Just caught the comment over on the blog and wanted to say hi. I haven't left, just withdrawn from the official forums. Actually I hopped over to SLU, although their scripting forums are dead as doornails, so I've been amusing myself in their PRS section. Sent in an NDA for the latest inworld beta review project, no reply yet ::shrug:: hope all is good on your end, and was pleasantly surprised you stopped by. Cheers -- '''[[User:Void_Singer|Void]]''' ([[User_talk:Void_Singer|talk]]|[[Special:Contributions/Void_Singer|contribs]]) 07:52, 22 December 2011 (PST)

: Things are going well here. beta? do they have a page describing it anywhere? I always loved betas. I stay mostly here on the wiki, wish I could get in world more, I hate writing documentation without being able to test the functionality. -- '''[[User:Strife_Onizuka|Strife]]''' ([[User talk:Strife_Onizuka|talk]]|[[Special:Contributions/Strife_Onizuka|contribs]]) 23:22, 22 December 2011 (PST)
:P.S. You are a braver soul than I to go into PRS.

No wiki page that I'm aware of, e-mail invitation letters (which seem to have been dispersed to many forumites, and turned down by a few) describe it as pre-release feedback review, of what specifically, I couldn't say (even if I knew yet). I'll ask if they'll bounce you a late entry since you seem interested. and yeah PRS is madness, but I'm largely word-proof so the invective is more like warm glow instead of singing flame for me, something to kill break time. happy new years and all that jazz -- '''[[User:Void_Singer|Void]]''' ([[User_talk:Void_Singer|talk]]|[[Special:Contributions/Void_Singer|contribs]]) 10:00, 26 December 2011 (PST)

:Thank you for offering but It's better if you don't. I wish I could thou I have no time (nor the internet connection) for it. If they sent me an invitation I'd feel obliged to accept and then not be able to do it justice. -- '''[[User:Strife_Onizuka|Strife]]''' ([[User talk:Strife_Onizuka|talk]]|[[Special:Contributions/Strife_Onizuka|contribs]]) 21:55, 26 December 2011 (PST)

Understood, I'll try to remember to ping ya when it goes live then, could be a bit, dunno quite how far they are out on it. -- '''[[User:Void_Singer|Void]]''' ([[User_talk:Void_Singer|talk]]|[[Special:Contributions/Void_Singer|contribs]]) 16:22, 27 December 2011 (PST)

== http_response event only be triggered for the originating script or triggered for all scripts ==

Hello Strife,

I just read the [http://wiki.secondlife.com/w/index.php?title=LlHTTPRequest&diff=1157547&oldid=1157508 note] you added concerning [[llHTTPRequest]].
Although this is of course a sane behavior, I was a bit surprised when I read it because I knew it wasn't the case before, I also have some script that depends on the old behavior and I didn't received any complaints concerning them.
So, I've just checked and I can confirm that, at least on my home sim which use the main server version, the event is still triggered on all scripts of the object which made the request.

By pure curiosity, I wonder if you have any additional information about this change.

Many thanks,
[[User:Elena Bouscario|Elena]] 11:45, 11 February 2012 (PST)

:I have no information on this unfortunately. My edit was a rewrite of the [https://wiki.secondlife.com/w/index.php?title=LlHTTPRequest&diff=1157508&oldid=1153608 previous edit] so that everything would read more clearly. Sounds like both edits should be reverted. -- '''[[User:Strife_Onizuka|Strife]]''' ([[User talk:Strife_Onizuka|talk]]|[[Special:Contributions/Strife_Onizuka|contribs]]) 10:45, 12 February 2012 (PST)

== capturing caveats in constants pages? ==

I'm trying to figure out the proper way to include a caveat in the [[DEBUG_CHANNEL]] and [[PUBLIC_CHANNEL]] pages, so that it properly inserts into articles referencing those two pages. The caveat is as follows
* Messages on channel_name are throttled to a rate of <200/2sec, per region, per owner/user.
** Once the rate is exceeded, all messages on channel_name will be dropped until the send rate is again below 200/2sec for the previous 2 sec.
not quite sure how to go about it though? -- '''[[User:Void_Singer|Void]]''' ([[User_talk:Void_Singer|talk]]|[[Special:Contributions/Void_Singer|contribs]]) 23:27, 21 August 2012 (PDT)

:I'd be inclined to work it into [[Template:LSL_Function/chat]] as well. No time now (and likely won't be able to see later, going to the eye doctor). -- '''[[User:Strife_Onizuka|Strife]]''' ([[User talk:Strife_Onizuka|talk]]|[[Special:Contributions/Strife_Onizuka|contribs]]) 08:30, 22 August 2012 (PDT)

:Arrg it's a rats nest. I'll work on it later. -- '''[[User:Strife_Onizuka|Strife]]''' ([[User talk:Strife_Onizuka|talk]]|[[Special:Contributions/Strife_Onizuka|contribs]]) 08:31, 22 August 2012 (PDT)

:I've put it in the template so now it's now everywhere... but still needs some tweaking. back later -- '''[[User:Strife_Onizuka|Strife]]''' ([[User talk:Strife_Onizuka|talk]]|[[Special:Contributions/Strife_Onizuka|contribs]])

Thanks, didn't mean to give you headaches over it =( I'll take a look at how you did it so maybe next time I can sort it myself -- '''[[User:Void_Singer|Void]]''' ([[User_talk:Void_Singer|talk]]|[[Special:Contributions/Void_Singer|contribs]]) 21:47, 22 August 2012 (PDT)

:It wasn't as bad as I thought it would be, no worries. -- '''[[User:Strife_Onizuka|Strife]]''' ([[User talk:Strife_Onizuka|talk]]|[[Special:Contributions/Strife_Onizuka|contribs]]) 08:48, 23 August 2012 (PDT)

== llGetTime/llResetTime ==
I saw you made a distinction between Mono and LSO for whether or not it's affected by dilation. However, empirical evidence doesn't seem to support this. While this may have been true in the past, it doesn't seem to be anymore. [[User:Darien Caldwell|Darien Caldwell]] 11:08, 13 September 2012 (PDT)

:That is great. :) I'll revert it. -- '''[[User:Strife_Onizuka|Strife]]''' ([[User talk:Strife_Onizuka|talk]]|[[Special:Contributions/Strife_Onizuka|contribs]]) 21:20, 13 September 2012 (PDT)

== Another world, another wiki ==

I don't suppose you have any tips for a budding documentor? I'm just learning mediawiki, and started function documentation over at Cloud Party (I didn't create the templates) http://wiki.cloudpartytime.com
BTW, do you use avisynth, or work on wiki docs for it? Still enjoy tinkering with avisyth scripts! [[User:Phate Shepherd|Phate Shepherd]] 16:43, 16 September 2012 (PDT)

:I'm sorry it's been taking me so long to respond, I'm working on articulating the my thoughts. I haven't forgotten you. I want to do the questions justice. Watch this space for an update soon. -- '''[[User:Strife_Onizuka|Strife]]''' ([[User talk:Strife_Onizuka|talk]]|[[Special:Contributions/Strife_Onizuka|contribs]]) 20:29, 19 September 2012 (PDT)

::No worries... So much to do and learn here! Thanks![[User:Phate Shepherd|Phate Shepherd]] 22:06, 21 September 2012 (PDT)

:I had a partial response all ready written and then my computer crashed. Here is a reconstruction:
:# Find some documentation you really like, and copy it's good features. Find some bad documentation and figure out what you don't like.
:# Write a mission statement for you wiki based documentation project. It should be short and concise. Then write a longer description after it as to what it means. As a matter of course your project will attract people sooner or later who won't share your vision. Having something in writing you can beat them over the head with will help reduce the toll the drama will have upon you. I'd give you more advise along these lines but it might be too specific and never crop up (it's the subtle difference between keeping a loaded gun and keeping a loaded cross bow that shoots wooden stakes). Be sure to have a well spelled out contribution policy, specifically content must be licensed under a wiki specified license but that doesn't mean the author cannot dual license it under another license if they so choose (they just can't choose to not license it under the wiki license).
:# Don't feel you need to do everything. You are a volunteer. You volunteer. You do it for free. You aren't obligated to do anything. It's not like they are paying you. So when you feel stressed, that it is going to hell, remember this, take a deep breath and relax, if they want to avert catastrophe they can spend money. If the catastrophe can't be averted with money then there is nothing you could do about it, so there is no reason for you to be stressed about it. It's not your problem.
:#* I have many wiki projects, in various states of completion. Some have been in the works for years, that is to say, I haven't really done anything with them for a considerable amount of time.
:# If you want something done, you will probably have to do it yourself. You won't be able to convince anyone else to do it. {{LSLGC|Needs_Example}} grows, it doesn't shrink.
:# Engage your community. Ask them what they want out of the documentation. Ask them how to make it better. This will encourage them to help you. Be prepared to hold their hands and show them how to edit the documentation. This is how you cultivate contributors. This is how you cultivate a contributor community.
:# The quality of documentation is determined by the audience. You should choose an audience to server and put that in your mission or goal statement. Serving a diverse audience is going to require negotiating some very complex tradeoffs.
:#* The LSL documentation have [[LSL_Portal_Guidelines|mission and goal statements]] that are at odds with each other. The type of help a beginner needs is not the same as that of an expert. A beginner needs it simple, an expert needs it precise. The solution is a layout that tries to divide the problem into manageable chunks. However getting that solution realized has been difficult.
:# If you have an issue tracker, add links in your documentation to pertinent issue in the tracker. Update them on a regular basis. If you can make it auto-update.
:P.S. Those templates are cool. I've been trying to mimic some of those features for years (not impossible but I run the risk of killing the wiki).
:-- '''[[User:Strife_Onizuka|Strife]]''' ([[User talk:Strife_Onizuka|talk]]|[[Special:Contributions/Strife_Onizuka|contribs]]) 21:10, 27 September 2012 (PDT)
::Thanks for taking to the time to write that out... I'll try and take it to heart. As for the "Find a wiki you like...." Well, that's why I came to you ;-) [[User:Phate Shepherd|Phate Shepherd]] 12:58, 28 September 2012 (PDT)

User talk:Strife Onizuka

2012-09-22T05:06:14Z

Phate Shepherd: /* Another world, another wiki */

User talk:Strife Onizuka

2012-09-16T23:43:33Z

Phate Shepherd: /* Another world, another wiki */ new section

User:Nyx Linden/Mesh Office Hours Agenda

2011-01-31T19:09:34Z

Phate Shepherd:

==Mesh Team's Office Hours Agenda==

Office hours are on Mondays at 11 AM in Pacific time (SL standard time) located on the beta grid (Aditi) in Mesh HQ 1 at: [secondlife://Aditi/secondlife/MeshHQ%201/251/250/24 Mesh HQ on Aditi]

Topics are focused on anything related to the mesh import project. Feature requests, bug reports, design feedback, questions, comments, or example content are welcome.

Please add topics for discussion / agenda items to the end of the list below prior to 10:50 AM. Priority will be given to topics that are posted in advance and are relevant to the goals of the office hour. Feel free to include relevant links to JIRA or wiki pages. Contact Nyx Linden or Runitai Linden if you are unsure if your topic is relevant or appropriate.

Archived agendas can be found at the [[User:Nyx_Linden/Mesh_Office_Hours_Agenda_Archive|agenda archive]].

Next meeting scheduled for: January 31, 2011.

===Agenda===

== January 31, 2011 ==
# Can you give us an update on recent progress, what your priorities are right now, and what (if anything) you need us to test and report on right now?
# Are we there yet?
# Could someone fix the links for changesets in the automatic build page from the non-working codeticket.lindenlab.com back to hg.secondlife.com links?
# Is it possible to translate the avatar OBJ files in second life Wiki into Collada file?
# Can we expect to see an official API for third party mesh importers ? (Or does the API already exist ?)
# What are the chances for getting rigged mesh scaling after the initial release? https://jira.secondlife.com/browse/CTS-452
# Joint position import: Or... I Own a Horse
# Your topic here

User:Nyx Linden/Mesh Office Hours Agenda

2011-01-31T19:02:14Z

Phate Shepherd:

User:Nyx Linden/Mesh Office Hours Agenda

2011-01-31T16:58:31Z

Phate Shepherd: /* January 31, 2011 */

==Mesh Team's Office Hours Agenda==

Office hours are on Mondays at 11 AM in Pacific time (SL standard time) located on the beta grid (Aditi) in Mesh HQ 1 at: [secondlife://Aditi/secondlife/MeshHQ%201/251/250/24 Mesh HQ on Aditi]

Topics are focused on anything related to the mesh import project. Feature requests, bug reports, design feedback, questions, comments, or example content are welcome.

Please add topics for discussion / agenda items to the end of the list below prior to 10:50 AM. Priority will be given to topics that are posted in advance and are relevant to the goals of the office hour. Feel free to include relevant links to JIRA or wiki pages. Contact Nyx Linden or Runitai Linden if you are unsure if your topic is relevant or appropriate.

Archived agendas can be found at the [[User:Nyx_Linden/Mesh_Office_Hours_Agenda_Archive|agenda archive]].

Next meeting scheduled for: January 31, 2011.

===Agenda===

== January 31, 2011 ==
# Can you give us an update on recent progress, what your priorities are right now, and what (if anything) you need us to test and report on right now?
# Are we there yet?
# Skeleton import issues... AKA: I Own A Horse.
# Your topic here

User:Nyx Linden/Mesh Office Hours Agenda

2011-01-31T16:58:11Z

Phate Shepherd: /* January 31, 2011 */

==Mesh Team's Office Hours Agenda==

Office hours are on Mondays at 11 AM in Pacific time (SL standard time) located on the beta grid (Aditi) in Mesh HQ 1 at: [secondlife://Aditi/secondlife/MeshHQ%201/251/250/24 Mesh HQ on Aditi]

Topics are focused on anything related to the mesh import project. Feature requests, bug reports, design feedback, questions, comments, or example content are welcome.

Please add topics for discussion / agenda items to the end of the list below prior to 10:50 AM. Priority will be given to topics that are posted in advance and are relevant to the goals of the office hour. Feel free to include relevant links to JIRA or wiki pages. Contact Nyx Linden or Runitai Linden if you are unsure if your topic is relevant or appropriate.

Archived agendas can be found at the [[User:Nyx_Linden/Mesh_Office_Hours_Agenda_Archive|agenda archive]].

Next meeting scheduled for: January 31, 2011.

===Agenda===

== January 31, 2011 ==
# Can you give us an update on recent progress, what your priorities are right now, and what (if anything) you need us to test and report on right now?
# Skeleton import issues... AKA: I Own A Horse.
# Are we there yet?
# Your topic here

Internal Animation Format

2010-09-06T20:16:05Z

Phate Shepherd: /* Joint Rotation Keys */

==Overview==

From a programming perspective, there are several steps to uploading an [[Animation|animation]] from a BVH (BioVision Hierarchy) file:

# Read and parse the BVH file, creating an LLKeyframeMotion object containing the motion data.
# Gather input from the user (via the upload preview floater) for things like animation priority, facial expression, and looping; these settings are stored in the LLKeyframeMotion object.
# Serialize the LLKeyframeMotion object as [[LLSD]].
# Upload the serialized data to the asset server.

Before other viewers can play an animation, they must:

# Download the serialized data from the asset server.
# Deserialize it to an LLKeyframeMotion object.

Relevant source files:
* ''linden/indra/llcharacter/llbvhloader.cpp''
* ''linden/indra/llcharacter/llkeyframemotion.cpp''.

==Header==

The first part of the animation data is a header describing various details about the animation as a whole. The elements, in order, are:

{|{{LLSD Field Table}}
{{LLSD Field Entry|name=version|llsd=integer|cpp=U16}}
{{LLSD Field Entry|name=sub_version|llsd=integer|cpp=U16}}
{{LLSD Field Entry|name=base_priority|llsd=integer|cpp=S32}}
{{LLSD Field Entry|name=duration|llsd=real|cpp=F32}}
{{LLSD Field Entry|name=emote_name|llsd=string|cpp=std::string}}
{{LLSD Field Entry|name=loop_in_point|llsd=real|cpp=F32}}
{{LLSD Field Entry|name=loop_out_point|llsd=real|cpp=F32}}
{{LLSD Field Entry|name=loop|llsd=integer|cpp=S32|note=0: not looped, 1: looped}}
{{LLSD Field Entry|name=ease_in_duration|llsd=real|cpp=F32}}
{{LLSD Field Entry|name=ease_out_duration|llsd=real|cpp=F32}}
{{LLSD Field Entry|name=hand_pose|llsd=integer|cpp=U32}}
{{LLSD Field Entry|name=num_joints|llsd=integer|cpp=U32}}
|}

==Joint Data==

After the header is data for each joint in the skeleton:

{|{{LLSD Field Table}}
{{LLSD Field Entry|name=joint_name|llsd=string|cpp=std::string}}
{{LLSD Field Entry|name=joint_priority|llsd=integer|cpp=S32}}
|}

===Joint Rotation Keys===

At the start of the rotation data is the total number of rotation keys:

{|{{LLSD Field Table}}
{{LLSD Field Entry|name=num_rot_keys|llsd=integer|cpp=S32}}
|}

Then, for each rotation key:

{|{{LLSD Field Table}}
{{LLSD Field Entry|name=time|llsd=integer|cpp=U16|note=0: first frame, 65535: last frame}}
{{LLSD Field Entry|name=rot_angle_x|llsd=integer|cpp=U16|note=32767: 0°, 0: 180° (Non linear!)}}
{{LLSD Field Entry|name=rot_angle_y|llsd=integer|cpp=U16}}
{{LLSD Field Entry|name=rot_angle_z|llsd=integer|cpp=U16}}
|}

===Joint Position Keys===

At the start of the position data is the total number of position keys:

{|{{LLSD Field Table}}
{{LLSD Field Entry|name=num_pos_keys|llsd=integer|cpp=S32}}
|}

Then, for each position key:

{|{{LLSD Field Table}}
{{LLSD Field Entry|name=time|llsd=integer|cpp=U16|note=0: first frame, 65535: last frame}}
{{LLSD Field Entry|name=pos_x|llsd=integer|cpp=U16|note=0: -5M, 32767: 0M, 65535: +5M}}
{{LLSD Field Entry|name=pos_y|llsd=integer|cpp=U16}}
{{LLSD Field Entry|name=pos_z|llsd=integer|cpp=U16}}
|}

==Constraints==

After the joint data are a number of entries for joint constraints. Constraints can target an avatar's parts in relation to each other or the ground.

{|{{LLSD Field Table}}
{{LLSD Field Entry|name=num_constraints|llsd=integer|cpp=S32}}
|}

Then, for each joint constraint:

{|{{LLSD Field Table}}
{{LLSD Field Entry|name=chain_length|llsd=integer|cpp=U8|note=number of attached joints to include}}
{{LLSD Field Entry|name=constraint_type|llsd=integer|cpp=U8|note=0: point, 1: plane}}
{{LLSD Field Entry|name=source_volume|llsd=string |cpp=U8[16] array|note=skeleton collision volume name}}
{{LLSD Field Entry|name=source_offset|llsd=string (?)|cpp=LLVector3}}
{{LLSD Field Entry|name=target_volume|llsd=string|cpp= U8[16] array|note=skeleton collision volume name}}
{{LLSD Field Entry|name=target_offset|llsd=string (?)|cpp=LLVector3}}
{{LLSD Field Entry|name=target_dir|llsd=string (?)|cpp=LLVector3|note=value is currently ignored}}
{{LLSD Field Entry|name=ease_in_start|llsd=real|cpp=F32}}
{{LLSD Field Entry|name=ease_in_stop|llsd=real|cpp=F32}}
{{LLSD Field Entry|name=ease_out_start|llsd=real|cpp=F32}}
{{LLSD Field Entry|name=ease_out_stop|llsd=real|cpp=F32}}
|}

Internal Animation Format

2010-09-06T20:13:56Z

Phate Shepherd: /* Joint Position Keys */

==Overview==

From a programming perspective, there are several steps to uploading an [[Animation|animation]] from a BVH (BioVision Hierarchy) file:

# Read and parse the BVH file, creating an LLKeyframeMotion object containing the motion data.
# Gather input from the user (via the upload preview floater) for things like animation priority, facial expression, and looping; these settings are stored in the LLKeyframeMotion object.
# Serialize the LLKeyframeMotion object as [[LLSD]].
# Upload the serialized data to the asset server.

Before other viewers can play an animation, they must:

# Download the serialized data from the asset server.
# Deserialize it to an LLKeyframeMotion object.

Relevant source files:
* ''linden/indra/llcharacter/llbvhloader.cpp''
* ''linden/indra/llcharacter/llkeyframemotion.cpp''.

==Header==

The first part of the animation data is a header describing various details about the animation as a whole. The elements, in order, are:

{|{{LLSD Field Table}}
{{LLSD Field Entry|name=version|llsd=integer|cpp=U16}}
{{LLSD Field Entry|name=sub_version|llsd=integer|cpp=U16}}
{{LLSD Field Entry|name=base_priority|llsd=integer|cpp=S32}}
{{LLSD Field Entry|name=duration|llsd=real|cpp=F32}}
{{LLSD Field Entry|name=emote_name|llsd=string|cpp=std::string}}
{{LLSD Field Entry|name=loop_in_point|llsd=real|cpp=F32}}
{{LLSD Field Entry|name=loop_out_point|llsd=real|cpp=F32}}
{{LLSD Field Entry|name=loop|llsd=integer|cpp=S32|note=0: not looped, 1: looped}}
{{LLSD Field Entry|name=ease_in_duration|llsd=real|cpp=F32}}
{{LLSD Field Entry|name=ease_out_duration|llsd=real|cpp=F32}}
{{LLSD Field Entry|name=hand_pose|llsd=integer|cpp=U32}}
{{LLSD Field Entry|name=num_joints|llsd=integer|cpp=U32}}
|}

==Joint Data==

After the header is data for each joint in the skeleton:

{|{{LLSD Field Table}}
{{LLSD Field Entry|name=joint_name|llsd=string|cpp=std::string}}
{{LLSD Field Entry|name=joint_priority|llsd=integer|cpp=S32}}
|}

===Joint Rotation Keys===

At the start of the rotation data is the total number of rotation keys:

{|{{LLSD Field Table}}
{{LLSD Field Entry|name=num_rot_keys|llsd=integer|cpp=S32}}
|}

Then, for each rotation key:

{|{{LLSD Field Table}}
{{LLSD Field Entry|name=time|llsd=integer|cpp=U16|note=0: first frame, 65535: last frame}}
{{LLSD Field Entry|name=rot_angle_x|llsd=integer|cpp=U16}}
{{LLSD Field Entry|name=rot_angle_y|llsd=integer|cpp=U16}}
{{LLSD Field Entry|name=rot_angle_z|llsd=integer|cpp=U16}}
|}

===Joint Position Keys===

At the start of the position data is the total number of position keys:

{|{{LLSD Field Table}}
{{LLSD Field Entry|name=num_pos_keys|llsd=integer|cpp=S32}}
|}

Then, for each position key:

{|{{LLSD Field Table}}
{{LLSD Field Entry|name=time|llsd=integer|cpp=U16|note=0: first frame, 65535: last frame}}
{{LLSD Field Entry|name=pos_x|llsd=integer|cpp=U16|note=0: -5M, 32767: 0M, 65535: +5M}}
{{LLSD Field Entry|name=pos_y|llsd=integer|cpp=U16}}
{{LLSD Field Entry|name=pos_z|llsd=integer|cpp=U16}}
|}

==Constraints==

After the joint data are a number of entries for joint constraints. Constraints can target an avatar's parts in relation to each other or the ground.

{|{{LLSD Field Table}}
{{LLSD Field Entry|name=num_constraints|llsd=integer|cpp=S32}}
|}

Then, for each joint constraint:

{|{{LLSD Field Table}}
{{LLSD Field Entry|name=chain_length|llsd=integer|cpp=U8|note=number of attached joints to include}}
{{LLSD Field Entry|name=constraint_type|llsd=integer|cpp=U8|note=0: point, 1: plane}}
{{LLSD Field Entry|name=source_volume|llsd=string |cpp=U8[16] array|note=skeleton collision volume name}}
{{LLSD Field Entry|name=source_offset|llsd=string (?)|cpp=LLVector3}}
{{LLSD Field Entry|name=target_volume|llsd=string|cpp= U8[16] array|note=skeleton collision volume name}}
{{LLSD Field Entry|name=target_offset|llsd=string (?)|cpp=LLVector3}}
{{LLSD Field Entry|name=target_dir|llsd=string (?)|cpp=LLVector3|note=value is currently ignored}}
{{LLSD Field Entry|name=ease_in_start|llsd=real|cpp=F32}}
{{LLSD Field Entry|name=ease_in_stop|llsd=real|cpp=F32}}
{{LLSD Field Entry|name=ease_out_start|llsd=real|cpp=F32}}
{{LLSD Field Entry|name=ease_out_stop|llsd=real|cpp=F32}}
|}

Internal Animation Format

2010-09-05T19:59:30Z

Phate Shepherd: /* Joint Rotation Keys */

==Overview==

From a programming perspective, there are several steps to uploading an [[Animation|animation]] from a BVH (BioVision Hierarchy) file:

# Read and parse the BVH file, creating an LLKeyframeMotion object containing the motion data.
# Gather input from the user (via the upload preview floater) for things like animation priority, facial expression, and looping; these settings are stored in the LLKeyframeMotion object.
# Serialize the LLKeyframeMotion object as [[LLSD]].
# Upload the serialized data to the asset server.

Before other viewers can play an animation, they must:

# Download the serialized data from the asset server.
# Deserialize it to an LLKeyframeMotion object.

Relevant source files:
* ''linden/indra/llcharacter/llbvhloader.cpp''
* ''linden/indra/llcharacter/llkeyframemotion.cpp''.

==Header==

The first part of the animation data is a header describing various details about the animation as a whole. The elements, in order, are:

{|{{LLSD Field Table}}
{{LLSD Field Entry|name=version|llsd=integer|cpp=U16}}
{{LLSD Field Entry|name=sub_version|llsd=integer|cpp=U16}}
{{LLSD Field Entry|name=base_priority|llsd=integer|cpp=S32}}
{{LLSD Field Entry|name=duration|llsd=real|cpp=F32}}
{{LLSD Field Entry|name=emote_name|llsd=string|cpp=std::string}}
{{LLSD Field Entry|name=loop_in_point|llsd=real|cpp=F32}}
{{LLSD Field Entry|name=loop_out_point|llsd=real|cpp=F32}}
{{LLSD Field Entry|name=loop|llsd=integer|cpp=S32|note=0: not looped, 1: looped}}
{{LLSD Field Entry|name=ease_in_duration|llsd=real|cpp=F32}}
{{LLSD Field Entry|name=ease_out_duration|llsd=real|cpp=F32}}
{{LLSD Field Entry|name=hand_pose|llsd=integer|cpp=U32}}
{{LLSD Field Entry|name=num_joints|llsd=integer|cpp=U32}}
|}

==Joint Data==

After the header is data for each joint in the skeleton:

{|{{LLSD Field Table}}
{{LLSD Field Entry|name=joint_name|llsd=string|cpp=std::string}}
{{LLSD Field Entry|name=joint_priority|llsd=integer|cpp=S32}}
|}

===Joint Rotation Keys===

At the start of the rotation data is the total number of rotation keys:

{|{{LLSD Field Table}}
{{LLSD Field Entry|name=num_rot_keys|llsd=integer|cpp=S32}}
|}

Then, for each rotation key:

{|{{LLSD Field Table}}
{{LLSD Field Entry|name=time|llsd=integer|cpp=U16|note=0: first frame, 65535: last frame}}
{{LLSD Field Entry|name=rot_angle_x|llsd=integer|cpp=U16}}
{{LLSD Field Entry|name=rot_angle_y|llsd=integer|cpp=U16}}
{{LLSD Field Entry|name=rot_angle_z|llsd=integer|cpp=U16}}
|}

===Joint Position Keys===

At the start of the position data is the total number of position keys:

{|{{LLSD Field Table}}
{{LLSD Field Entry|name=num_pos_keys|llsd=integer|cpp=S32}}
|}

Then, for each position key:

{|{{LLSD Field Table}}
{{LLSD Field Entry|name=time|llsd=integer|cpp=U16}}
{{LLSD Field Entry|name=pos_x|llsd=integer|cpp=U16}}
{{LLSD Field Entry|name=pos_y|llsd=integer|cpp=U16}}
{{LLSD Field Entry|name=pos_z|llsd=integer|cpp=U16}}
|}

==Constraints==

After the joint data are a number of entries for joint constraints. Constraints can target an avatar's parts in relation to each other or the ground.

{|{{LLSD Field Table}}
{{LLSD Field Entry|name=num_constraints|llsd=integer|cpp=S32}}
|}

Then, for each joint constraint:

{|{{LLSD Field Table}}
{{LLSD Field Entry|name=chain_length|llsd=integer|cpp=U8|note=number of attached joints to include}}
{{LLSD Field Entry|name=constraint_type|llsd=integer|cpp=U8|note=0: point, 1: plane}}
{{LLSD Field Entry|name=source_volume|llsd=string |cpp=U8[16] array|note=skeleton collision volume name}}
{{LLSD Field Entry|name=source_offset|llsd=string (?)|cpp=LLVector3}}
{{LLSD Field Entry|name=target_volume|llsd=string|cpp= U8[16] array|note=skeleton collision volume name}}
{{LLSD Field Entry|name=target_offset|llsd=string (?)|cpp=LLVector3}}
{{LLSD Field Entry|name=target_dir|llsd=string (?)|cpp=LLVector3|note=value is currently ignored}}
{{LLSD Field Entry|name=ease_in_start|llsd=real|cpp=F32}}
{{LLSD Field Entry|name=ease_in_stop|llsd=real|cpp=F32}}
{{LLSD Field Entry|name=ease_out_start|llsd=real|cpp=F32}}
{{LLSD Field Entry|name=ease_out_stop|llsd=real|cpp=F32}}
|}

Internal Animation Format

2010-09-05T19:40:52Z

Phate Shepherd: /* Header */

==Overview==

From a programming perspective, there are several steps to uploading an [[Animation|animation]] from a BVH (BioVision Hierarchy) file:

# Read and parse the BVH file, creating an LLKeyframeMotion object containing the motion data.
# Gather input from the user (via the upload preview floater) for things like animation priority, facial expression, and looping; these settings are stored in the LLKeyframeMotion object.
# Serialize the LLKeyframeMotion object as [[LLSD]].
# Upload the serialized data to the asset server.

Before other viewers can play an animation, they must:

# Download the serialized data from the asset server.
# Deserialize it to an LLKeyframeMotion object.

Relevant source files:
* ''linden/indra/llcharacter/llbvhloader.cpp''
* ''linden/indra/llcharacter/llkeyframemotion.cpp''.

==Header==

The first part of the animation data is a header describing various details about the animation as a whole. The elements, in order, are:

{|{{LLSD Field Table}}
{{LLSD Field Entry|name=version|llsd=integer|cpp=U16}}
{{LLSD Field Entry|name=sub_version|llsd=integer|cpp=U16}}
{{LLSD Field Entry|name=base_priority|llsd=integer|cpp=S32}}
{{LLSD Field Entry|name=duration|llsd=real|cpp=F32}}
{{LLSD Field Entry|name=emote_name|llsd=string|cpp=std::string}}
{{LLSD Field Entry|name=loop_in_point|llsd=real|cpp=F32}}
{{LLSD Field Entry|name=loop_out_point|llsd=real|cpp=F32}}
{{LLSD Field Entry|name=loop|llsd=integer|cpp=S32|note=0: not looped, 1: looped}}
{{LLSD Field Entry|name=ease_in_duration|llsd=real|cpp=F32}}
{{LLSD Field Entry|name=ease_out_duration|llsd=real|cpp=F32}}
{{LLSD Field Entry|name=hand_pose|llsd=integer|cpp=U32}}
{{LLSD Field Entry|name=num_joints|llsd=integer|cpp=U32}}
|}

==Joint Data==

After the header is data for each joint in the skeleton:

{|{{LLSD Field Table}}
{{LLSD Field Entry|name=joint_name|llsd=string|cpp=std::string}}
{{LLSD Field Entry|name=joint_priority|llsd=integer|cpp=S32}}
|}

===Joint Rotation Keys===

At the start of the rotation data is the total number of rotation keys:

{|{{LLSD Field Table}}
{{LLSD Field Entry|name=num_rot_keys|llsd=integer|cpp=S32}}
|}

Then, for each rotation key:

{|{{LLSD Field Table}}
{{LLSD Field Entry|name=time|llsd=integer|cpp=U16}}
{{LLSD Field Entry|name=rot_angle_x|llsd=integer|cpp=U16}}
{{LLSD Field Entry|name=rot_angle_y|llsd=integer|cpp=U16}}
{{LLSD Field Entry|name=rot_angle_z|llsd=integer|cpp=U16}}
|}

===Joint Position Keys===

At the start of the position data is the total number of position keys:

{|{{LLSD Field Table}}
{{LLSD Field Entry|name=num_pos_keys|llsd=integer|cpp=S32}}
|}

Then, for each position key:

{|{{LLSD Field Table}}
{{LLSD Field Entry|name=time|llsd=integer|cpp=U16}}
{{LLSD Field Entry|name=pos_x|llsd=integer|cpp=U16}}
{{LLSD Field Entry|name=pos_y|llsd=integer|cpp=U16}}
{{LLSD Field Entry|name=pos_z|llsd=integer|cpp=U16}}
|}

==Constraints==

After the joint data are a number of entries for joint constraints. Constraints can target an avatar's parts in relation to each other or the ground.

{|{{LLSD Field Table}}
{{LLSD Field Entry|name=num_constraints|llsd=integer|cpp=S32}}
|}

Then, for each joint constraint:

{|{{LLSD Field Table}}
{{LLSD Field Entry|name=chain_length|llsd=integer|cpp=U8|note=number of attached joints to include}}
{{LLSD Field Entry|name=constraint_type|llsd=integer|cpp=U8|note=0: point, 1: plane}}
{{LLSD Field Entry|name=source_volume|llsd=string |cpp=U8[16] array|note=skeleton collision volume name}}
{{LLSD Field Entry|name=source_offset|llsd=string (?)|cpp=LLVector3}}
{{LLSD Field Entry|name=target_volume|llsd=string|cpp= U8[16] array|note=skeleton collision volume name}}
{{LLSD Field Entry|name=target_offset|llsd=string (?)|cpp=LLVector3}}
{{LLSD Field Entry|name=target_dir|llsd=string (?)|cpp=LLVector3|note=value is currently ignored}}
{{LLSD Field Entry|name=ease_in_start|llsd=real|cpp=F32}}
{{LLSD Field Entry|name=ease_in_stop|llsd=real|cpp=F32}}
{{LLSD Field Entry|name=ease_out_start|llsd=real|cpp=F32}}
{{LLSD Field Entry|name=ease_out_stop|llsd=real|cpp=F32}}
|}

Internal Animation Format

2010-09-05T19:37:14Z

Phate Shepherd: /* Joint Position Keys */

==Overview==

From a programming perspective, there are several steps to uploading an [[Animation|animation]] from a BVH (BioVision Hierarchy) file:

# Read and parse the BVH file, creating an LLKeyframeMotion object containing the motion data.
# Gather input from the user (via the upload preview floater) for things like animation priority, facial expression, and looping; these settings are stored in the LLKeyframeMotion object.
# Serialize the LLKeyframeMotion object as [[LLSD]].
# Upload the serialized data to the asset server.

Before other viewers can play an animation, they must:

# Download the serialized data from the asset server.
# Deserialize it to an LLKeyframeMotion object.

Relevant source files:
* ''linden/indra/llcharacter/llbvhloader.cpp''
* ''linden/indra/llcharacter/llkeyframemotion.cpp''.

==Header==

The first part of the animation data is a header describing various details about the animation as a whole. The elements, in order, are:

{|{{LLSD Field Table}}
{{LLSD Field Entry|name=version|llsd=integer|cpp=U16}}
{{LLSD Field Entry|name=sub_version|llsd=integer|cpp=U16}}
{{LLSD Field Entry|name=base_priority|llsd=integer|cpp=S32}}
{{LLSD Field Entry|name=duration|llsd=real|cpp=F32}}
{{LLSD Field Entry|name=emote_name|llsd=string|cpp=std::string}}
{{LLSD Field Entry|name=loop_in_point|llsd=real|cpp=F32}}
{{LLSD Field Entry|name=loop_out_point|llsd=real|cpp=F32}}
{{LLSD Field Entry|name=loop|llsd=integer|cpp=S32}}
{{LLSD Field Entry|name=ease_in_duration|llsd=real|cpp=F32}}
{{LLSD Field Entry|name=ease_out_duration|llsd=real|cpp=F32}}
{{LLSD Field Entry|name=hand_pose|llsd=integer|cpp=U32}}
{{LLSD Field Entry|name=num_joints|llsd=integer|cpp=U32}}
|}

==Joint Data==

After the header is data for each joint in the skeleton:

{|{{LLSD Field Table}}
{{LLSD Field Entry|name=joint_name|llsd=string|cpp=std::string}}
{{LLSD Field Entry|name=joint_priority|llsd=integer|cpp=S32}}
|}

===Joint Rotation Keys===

At the start of the rotation data is the total number of rotation keys:

{|{{LLSD Field Table}}
{{LLSD Field Entry|name=num_rot_keys|llsd=integer|cpp=S32}}
|}

Then, for each rotation key:

{|{{LLSD Field Table}}
{{LLSD Field Entry|name=time|llsd=integer|cpp=U16}}
{{LLSD Field Entry|name=rot_angle_x|llsd=integer|cpp=U16}}
{{LLSD Field Entry|name=rot_angle_y|llsd=integer|cpp=U16}}
{{LLSD Field Entry|name=rot_angle_z|llsd=integer|cpp=U16}}
|}

===Joint Position Keys===

At the start of the position data is the total number of position keys:

{|{{LLSD Field Table}}
{{LLSD Field Entry|name=num_pos_keys|llsd=integer|cpp=S32}}
|}

Then, for each position key:

{|{{LLSD Field Table}}
{{LLSD Field Entry|name=time|llsd=integer|cpp=U16}}
{{LLSD Field Entry|name=pos_x|llsd=integer|cpp=U16}}
{{LLSD Field Entry|name=pos_y|llsd=integer|cpp=U16}}
{{LLSD Field Entry|name=pos_z|llsd=integer|cpp=U16}}
|}

==Constraints==

After the joint data are a number of entries for joint constraints. Constraints can target an avatar's parts in relation to each other or the ground.

{|{{LLSD Field Table}}
{{LLSD Field Entry|name=num_constraints|llsd=integer|cpp=S32}}
|}

Then, for each joint constraint:

{|{{LLSD Field Table}}
{{LLSD Field Entry|name=chain_length|llsd=integer|cpp=U8|note=number of attached joints to include}}
{{LLSD Field Entry|name=constraint_type|llsd=integer|cpp=U8|note=0: point, 1: plane}}
{{LLSD Field Entry|name=source_volume|llsd=string |cpp=U8[16] array|note=skeleton collision volume name}}
{{LLSD Field Entry|name=source_offset|llsd=string (?)|cpp=LLVector3}}
{{LLSD Field Entry|name=target_volume|llsd=string|cpp= U8[16] array|note=skeleton collision volume name}}
{{LLSD Field Entry|name=target_offset|llsd=string (?)|cpp=LLVector3}}
{{LLSD Field Entry|name=target_dir|llsd=string (?)|cpp=LLVector3|note=value is currently ignored}}
{{LLSD Field Entry|name=ease_in_start|llsd=real|cpp=F32}}
{{LLSD Field Entry|name=ease_in_stop|llsd=real|cpp=F32}}
{{LLSD Field Entry|name=ease_out_start|llsd=real|cpp=F32}}
{{LLSD Field Entry|name=ease_out_stop|llsd=real|cpp=F32}}
|}

Internal Animation Format

2010-09-05T19:36:51Z

Phate Shepherd: /* Joint Rotation Keys */

==Overview==

From a programming perspective, there are several steps to uploading an [[Animation|animation]] from a BVH (BioVision Hierarchy) file:

# Read and parse the BVH file, creating an LLKeyframeMotion object containing the motion data.
# Gather input from the user (via the upload preview floater) for things like animation priority, facial expression, and looping; these settings are stored in the LLKeyframeMotion object.
# Serialize the LLKeyframeMotion object as [[LLSD]].
# Upload the serialized data to the asset server.

Before other viewers can play an animation, they must:

# Download the serialized data from the asset server.
# Deserialize it to an LLKeyframeMotion object.

Relevant source files:
* ''linden/indra/llcharacter/llbvhloader.cpp''
* ''linden/indra/llcharacter/llkeyframemotion.cpp''.

==Header==

The first part of the animation data is a header describing various details about the animation as a whole. The elements, in order, are:

{|{{LLSD Field Table}}
{{LLSD Field Entry|name=version|llsd=integer|cpp=U16}}
{{LLSD Field Entry|name=sub_version|llsd=integer|cpp=U16}}
{{LLSD Field Entry|name=base_priority|llsd=integer|cpp=S32}}
{{LLSD Field Entry|name=duration|llsd=real|cpp=F32}}
{{LLSD Field Entry|name=emote_name|llsd=string|cpp=std::string}}
{{LLSD Field Entry|name=loop_in_point|llsd=real|cpp=F32}}
{{LLSD Field Entry|name=loop_out_point|llsd=real|cpp=F32}}
{{LLSD Field Entry|name=loop|llsd=integer|cpp=S32}}
{{LLSD Field Entry|name=ease_in_duration|llsd=real|cpp=F32}}
{{LLSD Field Entry|name=ease_out_duration|llsd=real|cpp=F32}}
{{LLSD Field Entry|name=hand_pose|llsd=integer|cpp=U32}}
{{LLSD Field Entry|name=num_joints|llsd=integer|cpp=U32}}
|}

==Joint Data==

After the header is data for each joint in the skeleton:

{|{{LLSD Field Table}}
{{LLSD Field Entry|name=joint_name|llsd=string|cpp=std::string}}
{{LLSD Field Entry|name=joint_priority|llsd=integer|cpp=S32}}
|}

===Joint Rotation Keys===

At the start of the rotation data is the total number of rotation keys:

{|{{LLSD Field Table}}
{{LLSD Field Entry|name=num_rot_keys|llsd=integer|cpp=S32}}
|}

Then, for each rotation key:

{|{{LLSD Field Table}}
{{LLSD Field Entry|name=time|llsd=integer|cpp=U16}}
{{LLSD Field Entry|name=rot_angle_x|llsd=integer|cpp=U16}}
{{LLSD Field Entry|name=rot_angle_y|llsd=integer|cpp=U16}}
{{LLSD Field Entry|name=rot_angle_z|llsd=integer|cpp=U16}}
|}

===Joint Position Keys===

At the start of the position data is the total number of position keys:

{|{{LLSD Field Table}}
{{LLSD Field Entry|name=num_pos_keys|llsd=integer|cpp=S32}}
|}

Then, for each position key:

{|{{LLSD Field Table}}
{{LLSD Field Entry|name=time|llsd=integer|cpp=U32}}
{{LLSD Field Entry|name=pos_x|llsd=integer|cpp=U16}}
{{LLSD Field Entry|name=pos_y|llsd=integer|cpp=U16}}
{{LLSD Field Entry|name=pos_z|llsd=integer|cpp=U16}}
|}

==Constraints==

After the joint data are a number of entries for joint constraints. Constraints can target an avatar's parts in relation to each other or the ground.

{|{{LLSD Field Table}}
{{LLSD Field Entry|name=num_constraints|llsd=integer|cpp=S32}}
|}

Then, for each joint constraint:

{|{{LLSD Field Table}}
{{LLSD Field Entry|name=chain_length|llsd=integer|cpp=U8|note=number of attached joints to include}}
{{LLSD Field Entry|name=constraint_type|llsd=integer|cpp=U8|note=0: point, 1: plane}}
{{LLSD Field Entry|name=source_volume|llsd=string |cpp=U8[16] array|note=skeleton collision volume name}}
{{LLSD Field Entry|name=source_offset|llsd=string (?)|cpp=LLVector3}}
{{LLSD Field Entry|name=target_volume|llsd=string|cpp= U8[16] array|note=skeleton collision volume name}}
{{LLSD Field Entry|name=target_offset|llsd=string (?)|cpp=LLVector3}}
{{LLSD Field Entry|name=target_dir|llsd=string (?)|cpp=LLVector3|note=value is currently ignored}}
{{LLSD Field Entry|name=ease_in_start|llsd=real|cpp=F32}}
{{LLSD Field Entry|name=ease_in_stop|llsd=real|cpp=F32}}
{{LLSD Field Entry|name=ease_out_start|llsd=real|cpp=F32}}
{{LLSD Field Entry|name=ease_out_stop|llsd=real|cpp=F32}}
|}

How to create animations

2009-04-27T17:59:14Z

Phate Shepherd:

{{Help
|Object=*
}}

An animation, in Second Life lingo, is a set of instructions that cause an [[avatar]] to engage in a sequence of motions.
You can use animations to make your avatar clap their hands, dance, blow someone a kiss, and much more.

Check out [http://www.gup.uni-linz.ac.at/~gk/Diplom/CART-Martin.pdf Martin Garstenauer's thesis] for a good introduction to the principles of character animation. Find out what a quaternion is. See [[Internal Animation Format]] for a description of the animation data format.

Custom animations can be created in programs such as Poser, Blender, and others. In 2005, one resident-made program was relased, called [http://caladan.nanosoft.ca/c4/software/posemaker.php Posemaker]([http://forums.secondlife.com/showthread.php?t=44734 ref-thread]). And in 2006, two Free ones were released: [http://www.avimator.com/ Avimator] ([http://forums.secondlife.com/showthread.php?t=81886 ref-thread]) and [http://sourceforge.net/projects/free-bvh-editor slat] ([http://forums.secondlife.com/showthread.php?t=83702 ref-thread]). In-World tools such as AnyPose ([http://forums.secondlife.com/showthread.php?t=307718 ref-thread]) and U-Poser ([http://forums.secondlife.com/showthread.php?t=170129 ref-thread]) can also be used to create animations for Second Life. Animations can be imported from these programs into Second Life by storing them as Biovision Hierarchy files, which have a file extension of BVH, and using the main menu '''File > Upload Animation''' command. There is a L$10 fee for uploading an animation. Animations can be previewed prior to uploading.

Animations can be used in [[gestures]] in Second Life but should not be confused with gestures.

Animations in one's [[inventory]] can be activated by double clicking the animation name in the inventory list, or by right-clicking the animation name and selecting '''Open''' from the context menu. This will produce a dialog box with the animation name, a field in which to see or enter a description of the animation, and two buttons: '''Play in World''' and '''Play Locally'''. '''Play Locally''' will cause the user to see the animation but it will not will be visible to other Residents. This is useful to make sure the animation is really something you want others to see your avatar doing. '''Play in World''' will cause the Residents within visual range to see your avatar perform the animation.

There are many animations available inworld, both free and for sale. You can get started locating some by pressing the '''Search''' button in the bottom of the SL screen, selecting the '''All''' tab, and entering "animation" as a search term.

== Basic Knowlege For Creating SL Animations ==

'''1. The BVH file''' 
The BVH is the text data that describes each figure part's rotation and position along a timeline.

'''2. Hip is the top''' 
Hip is the top of the hierarchy construction of figure in BVH. So, if you want to move the whole body, you have to move the hip.

'''3. Keyframe''' 
Animation is created by keyframe animation. It is an animation technique which builds the frame that sets up the position and rotation angle of the part called a keyframe. A computer carries out a complementary automatic calculation and creates the motions in frames between keyframes. A keyframe is built for every part.

'''4. The first frame''' 
You can create a stationary posture just by one frame animation, but note that you cannot move the whole body and cannot assign multiple priorities. This is convenient when you want an absolutely stiffened posture. The first frame of the animation that you created is used as reference information for the root part (hip) between BVH and SL. The first frame's posture doesn't appear inworld at all, but is recognized as a keyframe. Inworld animation only occurs after there is a difference from the position of the first frame and a rotation angle. Therefore, a stationary pose is actually composed to two separate frames. It is a good idea to set at zero on every parts' rotation and position at the first frame (a "T" pose) because it makes it easier to keep track of which parts you moved.

To recap: The first frame of an animation is a reference frame and is not shown in-world; any deviation from the first frame, however, will be interpreted as an avatar animation.

'''5. Spline interpolation''' 
If the tool has a spline interpolation feature, you may encounter some frustration until you knew how to control it. Use the cutting spline option which should be implemented too, such as <s>"[http://forums.secondlife.com/attachment.php?attachmentid=21043 Break spline]"</s>(link broken).

'''6. [http://en.wikipedia.org/wiki/Inverse_kinematics Inverse Kinematics]''' 
If the tool has the inverse kinematics feature and it's turned on, you might find it frustrating until you knew how to turn it off. Find it and learn how to turn it on/off.

'''7. Speed of the animation''' 
The default speed of animation is 30 FPS, that is it takes 1 second to play 30 frames. If you want 10-second animation, you need to create 300 frames. But you may also be able to change FPS value on each tool. And note that SL allows you to upload an animation up to 30 seconds.

'''8. Priority''' 
8-1: [[Internal_Animations|The default built-in animations]] are always available to your avatar in-world. They may have different priorities on each keyframed part, unlike uploaded animations which always have the same animation on the whole body. Unless you give a higher priority to your animations, your animations will be overriden by them in-world. Priorities range from 0 to 4, with 4 being the highest priority. See [[Internal_Animations|the default built-in animations]] page to make sure what kind of priority each animation has. 
8-2: Priority for uploaded animations is only given for the whole avatar, and is set in the uploading window. However, unless you animate each individual part of the avatar in your animation, some parts may be overridden by default animations (breathing, walking, etc.) 
8-3: A later playing animation is given priority over the former one when their priorities are the same.

'''9. Optimization''' 
SL's BVH importer does optimization of animation data prior to upload into SL. Joint rotations with very slight changes from keyframe to keyframe will be interpreted as *not* changing and thus aren't stored. This is done intentionally since custom animation data is stored on our servers and downloaded to each viewer as it is needed in real time, and needs to be fairly terse. 
The potential side effect of the optimization is what you have observed; joints with very subtle movement might have their animation data dropped entirely on upload. The threshold formula is complex, and involves comparing all three axes of data per joint, the distance moved between keyframes, as well as the joint's position in the skeletal hierachy.

'''10. Scale of the avatars' parts''' 
There is a difference between the scale of the figure's parts on the tool and your avatars in-world. Even if you adjust the position of parts on the tool, it may show you incorrectly in-world. You may see the avatar sitting while hovering or sinking under ground. The hip moves by the absolute value. Meanwhile, your avatar's height depends on the body shape of the avatar. You cannot help but keep in mind how they are suitable for the position and go back to the tool. Then you have to tweak them again while ignoring the shape of figure on the tool.

'''11. Facial and Hands morph''' 
Unfortunately, you cannot customize these animations. You can just select the built-in ones and add them to your animation on the uploading window. You can also evoke the built-in facial animations by script.

It is said those options [http://jira.secondlife.com/browse/VWR-1793 are] [http://jira.secondlife.com/browse/VWR-5587 broken] for a long time, however.

'''12. Uploading window''' 
1. Name: Your animation file's name. 
2. Description: You can write something here as a note. 
3. Priority: The range is 0-4. 4 is the highest value. 
4. Preview while: You can select several [[Internal Animations|internal animations]] to make sure your animation while playing. 
5. Loop: Click and put the check mark here to get a looping animation. It is not used when you create a stationary pose. 
6. In(%) & Out(%): You can select the range where you want to loop your animation in the whole timeline. Note, it starts from the first frame first, and then loops. So when you set 100% in the both fields, you can get an animation that starts moving and stops with the stationary pose at the last frame. 
7. Hand Pose: You can select and add one of the several hand morphs to your animation here (broken). 
8. Expression: You can select and add one of the several facial morphs to your animation here (broken too). 
9. Ease In(sec) & Ease Out(sec): This setting allows you to set the amount of time for your avatar to realistically ease (or morph or tween) into an animation from it's current pose, or out from the end of the animation into the next. A setting of 0.000 will cause your avatar to snap instantly into the new pose, instead of smoothly transitioning there. This setting is measured in seconds. 
10. Play & Stop buttons: You can play your animation to make sure before uploading here. 
11. Pose screen: Just click and drag up-down on the screen, the camera moves zoom in/out. Drag left-right, the camera turns around the figure. Hold '''Ctrl''', '''Shift''' or '''Alt''' and drag, and the camera can move in all directions.

== Creating Animations in Qavimator ==
Qavimator can be download here : http://www.qavimator.org/ 
A beginner's guide is also available [http://wiki.qavimator.org/index.php/Beginner%27s_Guide here]

<videoflash>h_-3c_aC-O4|250|206</videoflash>
[[Video Tutorial/Creating & uploading animations|Creating & uploading animations with Qavimator (normal video size)]]
== Creating Animations in Poser ==

''This addition to the Wiki is very Poser-5/6 centric.'' 

* The default Poser 6 has a lot of bugs including bvh exporting.You have to get the latest updated patch, SR2 or at least SR1 from [http://www.e-frontier.com/go/downloads Updates & Documentations].

=== Setting up Poser ===
First, you will want to get the Poser characters from [http://secondlife.com/community/avatar.php here].The ZIP file includes a BVH of the "default pose". Be sure to have that where you can find it easily. There are directions in the ZIP file for installing the characters so you can use them on Poser.

On the '''POSE''' tab screen of Poser, you should usually open the following windows. They are under the pull-down '''Window''' menu:

'''Parameter Dials: You can move or rotate the selected part by using these dials or inputting digits directly after clicking the value text. '''Animation Palette''': You can add and edit the whole frames and keyframes on each part. And you can play and make sure your animation from here.

Now you can see mainly three windows, the Preview in where the SL figure you added is, the '''Parameter Dials''' and the '''Animation Palette'''. 
On the '''Animation Palette''',you'll find all parts' name of the figure on the left side of the window. Green dots means keyframes. You will see them on the first frame. You can click and select any frame and add a keyframe by pressing the "plus" button on the upper side of the window. You can also delete it by the "minus" button. Click any frame and drag cursor, and you can select multiple frames of parts. 
You see "'''Play range'''" on the bottom of the '''Animation Palette'''. Tweak the range from the second frame to the end to play and make sure your animation without the first frame pose. 
Select '''General Preferences''' which is found under "Edit" on the main poser window. Click the interface tab and choose "'''Meters'''" instead of "'''Feet'''" . This is because SL uses meters as the standard unit. Then select "'''Launch to previous state'''" in the '''Launch Behavior''' section of the same tab and press "'''OK'''". Now you can get this state whenever you start Poser.

=== Creating a sitting pose ===
1. Input the value "2" in the right side field of "Of" where is theright top of the Animation Palette window to set up two frames as thewhole frame. 
2. Make sure when you select the second value of any part on theAnimation Palette or input the value "2" in the field between "Frame:"and "Of", it turns to be "Frame: 00002 Of 00002". This second frame becomes the starting frame in SL. 
3. Make sure you turn off Inverse Kinematics on the both of legs under "Figure" pull-down menu to move the whole body freely. 
4. Select Hip. You can select it by clicking the figure's hip directly on Preview window or clicking the second frame of Hip on the Animation Palette.

'''Note1: Hip is the top of the hierarchy construction of figure in SL(bvh). And "Body" and "CenterOfMass" parts aren't translated into BVH, so that they won't show any movement in world at all. What is worse that when you touch them, you'll be confused a lot because thegap of Poser and SL becomes large. You'd better not to move the both"Body" and "CenterOfMass".'''

5. Input "-0.4" in the field of "move down-up" on the Parameter Dials window. 
6. Select Left Thigh and input "-90" in the xRotate field on the Parameter Dials window. 
7. Select Left Shin and input "90" in the xRotate field on the Parameter Dials window. 
8. Select Left Foot and input "1" in the xRotate field on the Parameter Dials window so it's not to be overridden. (rf. Priority of The Basic Knowledge) 
9. Using "Symmetry" which is under the pull-down "Figure" menu and copy left legs to right legs. The dialog box doesn't matter which you selectbecause you're using symmetric scale parts figure. 
10. Save this file as a Poser file (pz3) because you might change this later. 
11. Select "Export/BVH motion..." under the pull-down "File" menu. And select "Scale automatically" on the dialog box before creating BVH file.

=== Uploading your animation ===

1. Select "Uplaod Animation" under the pull-down "File" menu where is the top of screen in world. 
2. Select your BVH file which you created. 
3. The upload window opens. You have to set the followings on the window. 
Priority: "4" (rf. Priority of The Basic Knowledge) 
4. Insert the check mark next to "Loop" by clicking. Pose is just the looping animation of the second frame. 
5. "In(%)" & "Out(%)" are from where start and to where end to play your animation in the whole frame. Now this doesn't matter because you created just one frame. 
6. "Pose Hand" & "Expression" are options. They are hand and face morph. 
7. In "Ease In(sec)" & "Ease Out(sec)", you can add time dilation to play and stop your animation. If you put "1"(sec) in "Ease In(sec)"field, the avatar will take 1 sec to sit while morphing. 
8. Press Play button and make sure how your animation is good. You can select "Preview while" pull-down menu, such as walking, sitting and so on.

'''Note2: You'll find the upper body moves while walking. It is because you didn't move them at all on Poser and the priority is set at the lowest.''' (rf. Priority of The Basic Knowledge)

9. Press "Upload(L$10)" button and get your animation.

'''Note3: You may see the avatar sitting while hovering or sinking underground. The hip moves by the absolute value. Meanwhile, your avatar's height depends on how you created them. The length of legs is up to avatars. Keep in mind how it is suitable for the height and go back to Poser. Then you have to create again while ignoring the shape of figure on Poser.'''

==== The simple whole body spinning animation : about priorities ====

1. Set the whole frames at 30 frames. 
2. Just create a keyframe on the hip at the 2nd frame. It becomes the 1st frame of animation in world. 
3. Make sure you turn off Inverse Kinematics on the both legs. 
4. Select the last frame and input value 360 in the "spin right-left" field on the Parameter Dials. 
5. You can see your proper aniamtion on Poser. 6. Uplodad your animation with Priority set at 4 and with Loop on.

Now, you'll find your animation odd. It spins but the head is doing a reverse rotation and looks in the state of still seeing the front. It is because the default built-in standing animation has a higher priority on its neck and head parts. You didn't move those parts in the process of creating it above and those parts are set at the lowest priority. They are thus overridden by the default standing animation.

Solution

Set the neck of the xRotate at 1(degree) and the head of the xRotate at -1(degree) on Poser.

=== The usage of Inverse Kinematics ===

Inverse Kinematics is one of the most useful tool to create animation. 
Let's learn how to use while you actually create animations. This sample is "Push-ups animation".

The female figure is used in this animation. 
1. Prepare 30 frames as the whole frame and select the 2nd frame to start to create your animation. 
2. Make sure you turn off Inverse Kinematics on all of the parts. 
3. Select Hip and input "90" in the "pitch up - down" field. 
4. You'd better see your figure from the side by Camera Control. 
5. Input "-0.4" in the "move up-down" field. 
6. Select Left Thigh and input "-20" in the "xRotate" field for its tiptoe to reach the floor. 
7. Control camera and see your figure from the front. 
8. Select Left Collar and input "-20" in the "forward - back" field. 
9. Select Left Shoulder and input "-60" in the "reach down - up" field. 
10. Select Left Forearm and input "-5" in the "bend front - back" field. 
11. Control camera and see your figure from the side again. 
12. Select Left Hand and input "90" in the "bend front - back" field. 
13. Now that you see the hand is floating from the floor a bit, select Abdomen and input "15" in the "bend back - forward" field. 
14. Select Chest and input "-10" in the "bend back -forward" field. 
15. And "-10" in the "bend up - down" field of both Neck and Head. 
16. Use "Symmetry" and copy the left side body to the right side one. 
17. '''Now turn on Inverse Kinematics on all of arms and legs.''' 
18. Select Hip and go to the 15th frame. 
19. Input "-0.7" in the "move down - up" field. 
20. You see legs and arms are also bent. 
21. Input "0.03" in the "move backwards - forwards" field to unbend legs. 
22. Select Abdomen and input "-5" in the "move back - forward" field. 
23. Input "-20" in the "back - forward" field of Chest, "bend up - down" field of Neck and Head. 
24. Select and copy Hip, Abdomen, Chest, Neck and Head at the second frame to the last frame. 
25. Go back to the second frame and ''break spline'' on those five keyframes. 
26. Delete the unnecessary camera's keyframes. 
27. Play your animation. 
28. You may notice the leg movements are a little bit odd. 
29. Select Hip and go to the 8th frame, and input "0.03" in the "move backwards - forwards" field to unbend legs. 
30. Go to the 23th frame, and input "0.03" in the "move backwards - forwards" field to shift the median point to forward a tad. 
31. Now you can see your figure do push-ups well on Poser. And you are sure to notice that you can make an animation with tweaking just a few parts of keyframes. 
32. Save it as the pz3 and export it into BVH. Upload it in world with Priority at 4 and Loop on. 
'''Note that you may find this animation looks bad for your Avatar inworld, such as hands are floating, legs are shivering. It is the exact scale issue. Try to change to several sizes' avatar and make sure it.'''

==See also==
* [[Animations]]
* [[Create Animations with Poser]]
* [[Internal Animations]]