BindToRoot (SCTRL) (Read 1746 times)

Started by Ricepigeon, September 22, 2015, 10:50:59 pm
Share this topic:
BindToRoot (SCTRL)
#1  September 22, 2015, 10:50:59 pm
  • *****
  • Gaps? Where we're going, we don't need gaps...
    • USA
If the player is a helper, binds the player to a specified position relative to its root. If the player is not a helper, this controller does nothing.

Required parameters:
Optional parameters:

    time = bind_time (int)
        Specify number of ticks that this binding should be effective. Defaults to 1.
    facing = facing_flag (int)
        If facing_flag is -1, makes the player always face the opposite direction from its root during the binding time. If facing_flag is 1, makes the player always face the same direction as its root during the binding time. If facing_flag is 0, the player will not turn regardless of what its root does. Defaults to 0.
    pos = pos_x (float), pos_y (float)
        pos_x and pos_y specify the offsets (from the root's axis) to bind to. Defaults to 0,0.

    If the player's root is destroyed (for example, if it is a helper, and executes DestroySelf), then the effect of BindToRoot is terminated.

Additional Notes:
There is a discrepancy in the docs for the BindToRoot controller; although the notes state that a helper's root can be destroyed by executing DestroySelf, a helper's root can never be another helper due to the fact that the root will always be a Non-helper (ie: Player 1). As such, the root can never execute the DestroySelf controller, nor can it ever be destroyed.