Simethereal DebugHudState

mitm · June 13, 2019, 12:12am

Not sure if this is desired behavior so figure should ask about it.

I know I could just remove debugHudState for production but just wondering if this is something I did to cause the “feature” I describe below to appear.

When first starting Simethereal client, DebugHudState is initialized. When we login, PlayerMovementState shows the position and speed in the DebugHUD.

github.com

Simsilica/Examples/blob/master/sim-eth-basic/src/main/java/example/view/PlayerMovementState.java#L174


                                 PlayerMovementFunctions.F_BOOST);
                                 
    // Grab the game session
    session = getState(ConnectionState.class).getService(GameSessionClientService.class);
    if( session == null ) {
        throw new RuntimeException("PlayerMovementState requires an active game session.");
    }
 
    this.models = getState(ModelViewState.class);
 
    if( getState(DebugHudState.class) != null ) {
        DebugHudState debug = getState(DebugHudState.class);
        this.positionDisplay = debug.createDebugValue("Position", DebugHudState.Location.Top);
        this.speedDisplay = debug.createDebugValue("Speed", DebugHudState.Location.Top); 
    }
}

@Override
protected void cleanup(Application app) {

    inputMapper.removeAnalogListener(this,

When we disconnect, not exit, we get dumped back to the MainMenuState and here I am seeing these two nodes (Position:, Speed:) still at the top of the screen where you enter the host and port.

Upon logging back in, they duplicate.

I fixed this by just checking for the DebugHudState in cleanup of PlayerMovementState and just removing the values for position and speed

        if( getState(DebugHudState.class) != null ) {
            DebugHudState debug = getState(DebugHudState.class);
            debug.removeDebugValue("Position");
            debug.removeDebugValue("Speed"); 
        }

after removeStateListener.

github.com

Simsilica/Examples/blob/master/sim-eth-basic/src/main/java/example/view/PlayerMovementState.java#L191


@Override
protected void cleanup(Application app) {

    inputMapper.removeAnalogListener(this,
                                     PlayerMovementFunctions.F_Y_ROTATE,
                                     PlayerMovementFunctions.F_X_ROTATE,
                                     PlayerMovementFunctions.F_THRUST,
                                     PlayerMovementFunctions.F_ELEVATE,
                                     PlayerMovementFunctions.F_STRAFE);
    inputMapper.removeStateListener(this,
                                    PlayerMovementFunctions.F_BOOST);
}

@Override
protected void onEnable() {
    log.info("onEnable()");

    // Make sure our input group is enabled
    inputMapper.activateGroup(PlayerMovementFunctions.G_MOVEMENT);
    
    // And kill the cursor

Just wondering if this “feature” was intended or something I caused so I am defensive coding.

mitm · June 13, 2019, 1:03am

I forgot I have sim-eth-es setup for study so I checked it out and it does same thing so I am thinking this is an oversight so if confirmed, i will submit Pr’s tommorrow.

pspeed · June 13, 2019, 1:23am

Yep, just an oversight.