SimpleAdventureShared

'''
This file is used in a simple adventure game to teach the use of classes.
To run this application you need 4 files:
SimpleAdventureProgram.py:    https://pastebin.com/jm9aHBWR
  (mimics C# Program.cs class with Main() function as entry point)
SimpleAdventureLocation.py:    https://pastebin.com/xREn6WB9
  (Class containing properties of exits to/from other locations, name and description)
SimpleAdventureShared.py:    https://pastebin.com/9hRT5XA2
  (Static class containing project-scope global variables and various methods)
GetInput.py: https://pastebin.com/UceAJsaV
  (Static class with functions to get user input and display menus)

This is the Python equivalent of a static class, so does not have a constructor.

This file is used to store global variables, without the confusion caused by needing the declaration 'global'
dotted around except for one single function in this file only: def SetCurrentLocation(locationName):
'''
dictLocations = {}
currentLocation = object() # will be a pointer to one of the Locations after creation. object() used as placeholder
# nearest equvalent to C# / Java's: Location currentLocation = new Location();

def CheckLocations():
    keys = []
    wrong_keys = []
    # check if each LocationToXXX corresponds with a key
    for k in dictLocations.keys():
        keys.append(k)
    for location in dictLocations.values():
        if location.LocationToNorth != "":
            if location.LocationToNorth not in keys:
                wrong_keys.append(location.LocationToNorth)
        if location.LocationToEast != "":
            if location.LocationToEast not in keys:
                wrong_keys.append(location.LocationToEast)
        if location.LocationToSouth != "":
            if location.LocationToSouth not in keys:
                wrong_keys.append(location.LocationToSouth)
        if location.LocationToWest != "":
            if location.LocationToWest not in keys:
                wrong_keys.append(location.LocationToWest)

    return wrong_keys #List of strings

def MoveLocation(direction):
    if direction == "n":
        SetCurrentLocation(currentLocation.LocationToNorth)
    elif direction == "e":
        SetCurrentLocation(currentLocation.LocationToEast)
    elif direction == "s":
        SetCurrentLocation(currentLocation.LocationToSouth)
    elif direction == "w":
        SetCurrentLocation(currentLocation.LocationToWest)

def GetNextLocation(direction):
    if direction == "n":
        return dictLocations[currentLocation.LocationToNorth]
    elif direction == "e":
        return dictLocations[currentLocation.LocationToEast]
    elif direction == "s":
        return dictLocations[currentLocation.LocationToSouth]
    elif direction == "w":
        return dictLocations[currentLocation.LocationToWest]

def GetNextLocationName(direction):
    if direction == "n":
        return dictLocations[currentLocation.LocationToNorth].DisplayName
    elif direction == "e":
        return dictLocations[currentLocation.LocationToEast].DisplayName
    elif direction == "s":
        return dictLocations[currentLocation.LocationToSouth].DisplayName
    elif direction == "w":
        return dictLocations[currentLocation.LocationToWest].DisplayName

def PrintLocationDebug():
    print("*********************Debug Location Start***********************\n")
    for k, v in dictLocations.items():
        print("Location: " + k)
        print("\tDisplayName: " + v.DisplayName)
        print("\tDescription: " + v.Description)
        print("\tExits: " + str(v.LocationList()))
    print("*********************Debug Location End*************************\n")

def SetCurrentLocation(locationName):
    global currentLocation #This value is changed in this function, so python requires this statement!
    currentLocation = dictLocations[locationName]