Input, Mappings & Controls

3.2.Methods #

This area covers each API function call available in the scripting system.

//Prints the given variable to the debug log
void print(string)

//Converts the given variable to a string
void to_string(var)

// The script will pause for x milliseconds
void Sleep(int ms)

// Checks if the hotkey assigned to the script is active. Returns true if button == down or axis >= threshold
bool HotkeyActive()

// Returns the current value of the given axis/button
// axis value range -128 to 128 and buttons return 0 or 255 for pressed. 
int GetValue(axis/button)

// Sets internal script controller state of 'axis' to value - *Does not send input to Remote Play, use in conjuction with 'Send' method!*
// value range -128 to 128
void MoveAxis(axis, int value)

// Updates internal state and sends input. Blocks until input has been sent. 
// value range -128 to 128
void SendAxis(axis, int value)

// Resets all axis to 0 and sends. Blocks until input has been sent. 
void ResetAxis()

// Sets internal script controller state of 'trigger' to value - *Does not send input to Remote Play, use in conjuction with 'Send' method!*
// value range 0 to 255
void SetTrigger(trigger, int value)

// Updates internal state and sends input. Blocks until input has been sent. 
// value range 0 to 255
void SendTrigger(trigger, int value)

// Resets all Triggers to 0 and sends. Blocks until input has been sent. 
void ResetTriggers()

// Sets internal script controller state of 'button' to pressed - *Does not send input to Remote Play, use in conjuction with 'Send' method!*
void Press(button)

// Sets internal script controller state of 'button' to released - *Does not send input to Remote Play, use in conjuction with 'Send' method!*
void Release(button)

// Updates internal state and sends input. Blocks until input has been sent. 
// value true or false
void SendButton(button, bool pressed)

// Resets all button to unpressed and sends. Blocks until input has been sent. 
void ResetButtons()

// Updates internal state and sends input. Blocks until input has been sent. 
// value x range 0 to 1920
// value y range 0 to 942
void SendTouch(touch, int x, int y)

// Resets touchpad touches and sends. Blocks until input has been sent. 
void ResetTouchpad()

// Send the current controller state to RemotePlay
void Send()

// Resets all input and sends. Blocks until input has been sent. 
void ResetState()

// The script will pause for x milliseconds, returns early with false if Hotkey was released during Sleep else returns true. 
bool SleepOnHotkey(int ms)

// Applys the provided value to the axis instead of overwriting like 'MoveAxis' - *Does not send input to Remote Play, use in conjuction with 'Send' method!*
// value range -128 to 128
ApplyAxisForce(axis, int value)
  
// Removes any applied force to axis - *Does not send input to Remote Play, use in conjuction with 'Send' method!*
RemoveAxisForce(axis)

//Gets the ID of the current config, ID will range from 1 to 10
int GetConfig()

//Sets the current config
void SetConfig(int)

Help Guide Powered by Documentor
Suggest Edit