Difference between revisions of "Game control"

From Second Life Wiki
Jump to navigation Jump to search
(change game_control signature to use bitfields instead of lists for buttons)
(update example script)
Line 1: Line 1:
{{LSL_Event|event_id=40|event_delay|event=game_control
{{LSL_Event|event_id=40|event_delay|event=game_control
|p1_type=key|p1_name=id|p1_desc=avatar UUID
|p1_type=key|p1_name=id|p1_desc=avatar UUID
|p2_type=list|p2_name=button_levels|p2_desc=bitfield of buttons held down
|p2_type=integer|p2_name=button_levels|p2_desc=bitfield of buttons held down
|p3_type=list|p3_name=button_edges|p3_desc=bitfield of buttons that have changed
|p3_type=integer|p3_name=button_edges|p3_desc=bitfield of buttons that have changed
|p4_type=list|p4_name=axes|p4_desc=list of axes values in range [-1, 1]
|p4_type=list|p4_name=axes|p4_desc=list of axes values in range [-1, 1]
|event_desc='''Experimental''' event only available in some testing regions (soon).  Triggered when compatible viewer sends fresh '''GameControlInput''' message, but only for scripts on attachments or seat.
|event_desc='''Experimental''' event only available in some testing regions (soon).  Triggered when compatible viewer sends fresh '''GameControlInput''' message, but only for scripts on attachments or seat.
Line 14: Line 14:
|examples=
|examples=
<syntaxhighlight lang="lsl2">
<syntaxhighlight lang="lsl2">
print_list(string name, integer type, list data)
integer print_list(string name, integer type, list data)
{
{
     integer data_length = llGetListLength(data);
     integer data_length = llGetListLength(data);
Line 44: Line 44:
         }
         }
     }
     }
     llOwnerSay(text);
     llOwnerSay(text);
    return data_length;
}
 
string bits2nybbles(integer bits)
{
    integer lsn; // least significant nybble
    string nybbles = "";
    do
        nybbles = llGetSubString("0123456789ABCDEF", lsn = (bits & 0xF), lsn) + nybbles;
    while (bits = (0xfffFFFF & (bits >> 4)));
    return nybbles;
}
}


Line 51: Line 62:
     state_entry()
     state_entry()
     {
     {
         llOwnerSay("attach or sit");
         llOwnerSay("Ready for game_control events");
     }
     }
     game_control(key id, list buttons_down_edge, list buttons_up_edge, list buttons_down, list axes)
   
     game_control(key id, integer button_levels, integer button_edges, list axes)
     {
     {
        string button_levels_hex = bits2nybbles(button_levels);
        string button_edges_hex = bits2nybbles(button_edges);
         llOwnerSay("game_control :");
         llOwnerSay("game_control :");
         print_list("  edge_down", TYPE_INTEGER, buttons_down_edge);
         llOwnerSay("  button_levels=0x" + button_levels_hex);
         print_list("  edge_up", TYPE_INTEGER, buttons_up_edge);
         llOwnerSay("  button_edges=0x" + button_edges_hex);
        print_list("  down", TYPE_INTEGER, buttons_down);
         print_list("  axes", TYPE_FLOAT, axes);
         print_list("  axes", TYPE_FLOAT, axes);
     }
     }
}
}
</syntaxhighlight>
</syntaxhighlight>
|helpers
|helpers

Revision as of 16:08, 18 October 2023

Description

Event: game_control( key id, integer button_levels, integer button_edges, list axes ){ ; }

Experimental event only available in some testing regions (soon). Triggered when compatible viewer sends fresh GameControlInput message, but only for scripts on attachments or seat.

• key id avatar UUID
• integer button_levels bitfield of buttons held down
• integer button_edges bitfield of buttons that have changed
• list axes list of axes values in range [-1, 1]

Template:LSL Constants/GameControlInputs

Caveats

  • If enabled at the client: unhandled keystrokes will be treated as button presses.
  • There is room for 32 buttons [bits 0 through 31] however at most only 16 buttons can be simultaneously held down at any one time.
  • button_edges is computed using old an new button_levels between events, not between when the data arrives by network packet from the client. If the script is unable to process events fast enough then some rapid down-up or up-down edges may be lost.
  • There are always 6 axes values, even when the controller device has more or less
    • All axes elements will be in range [-1,1] except for GAME_CONTROL_AXIS_TRIGGERLEFT and GAME_CONTROL_AXIS_TRIGGERRIGHT which range [0, 1]


Examples

integer print_list(string name, integer type, list data)
{
    integer data_length = llGetListLength(data);
    string text = name + " : ";
    if (data_length > 0)
    {
        integer use_comma = FALSE;
        integer i = 0;
        for (i = 0; i < data_length; i++)
        {
            if (!use_comma)
            {
                use_comma = TRUE;
            }
            else
            {
                text += ",";
            }
            if (type == TYPE_INTEGER)
            {
                integer b = (llList2Integer(data, i));
                text += (string)(b);
                llOwnerSay("pack i=" + (string)(i) + " b=" + (string)(b));
            }
            else if (type == TYPE_FLOAT)
            {
                text += (string)(llList2Float(data, i));
            }
        }
    }
    llOwnerSay(text); 
    return data_length;
}

string bits2nybbles(integer bits)
{
    integer lsn; // least significant nybble
    string nybbles = "";
    do
        nybbles = llGetSubString("0123456789ABCDEF", lsn = (bits & 0xF), lsn) + nybbles;
    while (bits = (0xfffFFFF & (bits >> 4)));
    return nybbles;
}

default
{
    state_entry()
    {
        llOwnerSay("Ready for game_control events");
    }
    
    game_control(key id, integer button_levels, integer button_edges, list axes)
    {
        string button_levels_hex = bits2nybbles(button_levels);
        string button_edges_hex = bits2nybbles(button_edges);
        llOwnerSay("game_control :");
        llOwnerSay("  button_levels=0x" + button_levels_hex);
        llOwnerSay("  button_edges=0x" + button_edges_hex);
        print_list("  axes", TYPE_FLOAT, axes);
    }
}

See Also

Events

•  control

Deep Notes

Signature

event void game_control( key id, integer button_levels, integer button_edges, list axes );