Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

make xHighLevelStarTrekDoor.py to be less bad #1470

Merged
merged 5 commits into from
Oct 3, 2024
Merged

make xHighLevelStarTrekDoor.py to be less bad #1470

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
94a370c
Remove reliance on age owner
Hazado Aug 16, 2023
afd7a85
Requested Changes
Hazado Aug 17, 2023
64bd83d
Requested changes
Hazado Aug 20, 2023
3f581d5
additional changes
Hazado Sep 8, 2023
9f872d0
move no arbitration into onServerInitComplete()
Hazado Nov 7, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
302 changes: 74 additions & 228 deletions Scripts/Python/xHighLevelStarTrekDoor.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,16 +49,26 @@

from Plasma import *
from PlasmaTypes import *
from enum import IntEnum


strDoorClosedVar = ptAttribString(1, "Door Closed SDL Var")
xrgnDoorBlocker = ptAttribExcludeRegion(2,"Exclude Region")
rgnSensor = ptAttribActivator(3, "Region Sensor")
respOpenDoor = ptAttribResponder(4, "Open door Responder", netForce=0)
respCloseDoor = ptAttribResponder(5, "Close door Responder", netForce=0)
respOpenDoor = ptAttribResponder(4, "Open door Responder", netForce=False, netPropagate=False)
respCloseDoor = ptAttribResponder(5, "Close door Responder", netForce=False, netPropagate=False)
strDoorEnabledVar = ptAttribString(6, "Door Enabled SDL Var (optional)")

doorSDLstates = {'closed':0,'opening':1,'open':2,'closing':3,'opentoclose':4,'closetoopen':5,'movingopen':6,'movingclosed':7}
#doorSDLstates = {'closed':0,'opening':1,'open':2,'closing':3,'opentoclose':4,'closetoopen':5,'movingopen':6,'movingclosed':7}
class doorSDLstates(IntEnum):
closed = 0
opening = 1
open = 2
closing = 3
opentoclose = 4
closetoopen = 5
movingopen = 6
movingclosed = 7
Comment on lines +63 to +71
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think I want us to work on these state names so that what is going on is a little more clear. I know that I still need to open this file in VS Code (instead of viewing the diff, which is basically useless) to really understand what all is going on here.


class xHighLevelStarTrekDoor(ptModifier):
##########################################
Expand All @@ -68,19 +78,13 @@ def __init__(self):
self.version = 3

PtDebugPrint("DEBUG: xHighLevelStarTrekDoor.__init__: v. %d" % self.version)

self.PrevDoorState = 0
self.DoorState = 0
self.DoorStack = []

self.DoorEnabled = 1
self.respondertime = 30

##########################################
def OnServerInitComplete(self):

ageSDL = PtGetAgeSDL()
ageSDL.sendToClients(strDoorEnabledVar.value)
ageSDL.sendToClients(strDoorClosedVar.value)
ageSDL.setFlags(strDoorEnabledVar.value, 1, 1)
ageSDL.setFlags(strDoorClosedVar.value, 1, 1)
ageSDL.setNotify(self.key,strDoorEnabledVar.value,0.0)
Expand All @@ -94,46 +98,31 @@ def OnServerInitComplete(self):
PtDebugPrint("ERROR: xHighLevelStarTrekDoor.OnServerInitComplete():\tERROR: age sdl read failed, defaulting door enabled value")
else:
self.DoorEnabled = 1

try:
self.DoorState = self.SDL['DoorState'][0]
self.SDL['DoorState'][0]
except:
self.SDL['DoorState'] = (0,)
self.DoorState = self.SDL['DoorState'][0]

PtDebugPrint("xHighLevelStarTrekDoor: self.SDL = %d" % self.DoorState)

PtDebugPrint(f"xHighLevelStarTrekDoor: {self.SDL['DoorState'][0]=}")

if not PtIsSolo():

PtDebugPrint("xHighLevelStarTrekDoor: Somebody is already in the age. Attempting to sync states.")

if self.DoorState == doorSDLstates['opening'] or self.DoorState == doorSDLstates['movingopen'] or self.DoorState == doorSDLstates['opentoclose']:
respOpenDoor.run(self.key,netPropagate=0)
self.DoorStack.append("respOpenDoor.run(self.key,netPropagate=0)")

'''
respOpenDoor.run(self.key,fastforward=1)
self.DoorState = doorSDLstates['open']
PtDebugPrint("xHighLevelStarTrekDoor: Door is open.")
'''

elif self.DoorState == doorSDLstates['closing'] or self.DoorState == doorSDLstates['movingclosed'] or self.DoorState == doorSDLstates['closetoopen']:
respCloseDoor.run(self.key,netPropagate=0)
self.DoorStack.append("respCloseDoor.run(self.key,netPropagate=0)")
'''
respCloseDoor.run(self.key,fastforward=1)
self.DoorState = doorSDLstates['closed']
PtDebugPrint("xHighLevelStarTrekDoor: Door is closed.")
'''

elif self.DoorState == doorSDLstates['open']:
respOpenDoor.run(self.key,fastforward=1)

if self.SDL['DoorState'][0] in (doorSDLstates.opening, doorSDLstates.movingopen, doorSDLstates.opentoclose):
respOpenDoor.run(self.key)
elif self.SDL['DoorState'][0] in (doorSDLstates.closing, doorSDLstates.movingclosed, doorSDLstates.closetoopen):
respCloseDoor.run(self.key)
elif self.SDL['DoorState'][0] == doorSDLstates.open:
respOpenDoor.run(self.key,fastforward=True)

else:
# the door is really shut, someone left it open
self.SDL['DoorState'] = (doorSDLstates['closed'],)
self.DoorState = self.SDL['DoorState'][0]
self.SDL['DoorState'] = (doorSDLstates.closed,)
ageSDL[strDoorClosedVar.value] = (1,)

rgnSensor.volumeSensorNoArbitration(True)

##########################################
def OnSDLNotify(self,VARname,SDLname,playerID,tag):
Expand All @@ -144,219 +133,76 @@ def OnSDLNotify(self,VARname,SDLname,playerID,tag):
elif VARname == strDoorClosedVar.value:
doorClosed = ageSDL[strDoorClosedVar.value][0]
PtDebugPrint("HighLevelStarTrekDoor.OnSDLNotify: Door Closed SDL Updated to: %d" % doorClosed)
PtDebugPrint("HighLevelStarTrekDoor.OnSDLNotify: Player who updated SDL: ", playerID)
if playerID == 0 and self.sceneobject.isLocallyOwned():
if doorClosed == 0:
self.SendNote("respOpenDoor;1")
self.UpdateDoorState(doorSDLstates['open'])
elif doorClosed == 1:
self.SendNote("respCloseDoor;1")
self.UpdateDoorState(doorSDLstates['closed'])
if doorClosed:
respCloseDoor.run(self.key)
else:
respOpenDoor.run(self.key)

##########################################
def OnNotify(self,state,id,events):

ageSDL = PtGetAgeSDL()
doorState = self.SDL['DoorState'][0]
#Notify Section
if id == (-1):
if events[0][1].find('rgnTriggerEnter') != -1 and self.sceneobject.isLocallyOwned():
PtDebugPrint("xHighLevelStarTrekDoor: Avatar who entered the region. ",events[0][1].lstrip("rgnTriggerEnter"))
if self.DoorState == doorSDLstates['closed']:
self.UpdateDoorState(doorSDLstates['opening'])
PtDebugPrint("xHighLevelStarTrekDoor: Setting Door to opening.")

elif self.DoorState == doorSDLstates['movingclosed'] or self.DoorState == doorSDLstates['closing']:
self.UpdateDoorState(doorSDLstates['closetoopen'])
PtDebugPrint("xHighLevelStarTrekDoor: Setting Door to closetoopen.")

elif self.DoorState == doorSDLstates['opentoclose']:
self.UpdateDoorState(doorSDLstates['movingopen'])
PtDebugPrint("xHighLevelStarTrekDoor: Setting Door to movingopen.")
return

elif events[0][1].find('rgnTriggerExit') != -1 and self.sceneobject.isLocallyOwned():
PtDebugPrint("xHighLevelStarTrekDoor: Avatar who exited the region. ",events[0][1].lstrip("rgnTriggerExit"))
if self.DoorState == doorSDLstates['open']:
self.UpdateDoorState(doorSDLstates['closing'])
PtDebugPrint("xHighLevelStarTrekDoor: Setting Door to closing.")

elif self.DoorState == doorSDLstates['movingopen'] or self.DoorState == doorSDLstates['opening']:
self.UpdateDoorState(doorSDLstates['opentoclose'])
PtDebugPrint("xHighLevelStarTrekDoor: Setting Door to opentoclose.")

elif self.DoorState == doorSDLstates['closetoopen']:
self.UpdateDoorState(doorSDLstates['movingclosed'])
PtDebugPrint("xHighLevelStarTrekDoor: Setting Door to movingclosed.")
return


elif events[0][1].find('respOpenDoor') != -1 or events[0][1].find('respCloseDoor') != -1:
self.DoorStack.append(events[0][1])
PtDebugPrint("xHighLevelStarTrekDoor: New list is: %s" % (str(self.DoorStack)))

if len(self.DoorStack) == 1:
PtDebugPrint("xHighLevelStarTrekDoor: List is only one command long, so I'm playing it")
code = self.DoorStack[0]
#PtDebugPrint("xHighLevelStarTrekDoor: Timer set to : %d" % self.respondertime)
#PtAtTimeCallback(self.key,self.respondertime,1)
PtDebugPrint("xHighLevelStarTrekDoor: Playing command: %s" % (code))
self.ExecCode(code)
if self.DoorStack[0].find('fastforward=1') != -1:
self.UpdateRespStack()
return


elif events[0][1].find('DoorState') != -1 and events[0][1].find('rgnTriggerEnter') == -1 and events[0][1].find('rgnTriggerExit') == -1 and events[0][1].find('Responder') == -1:
#PtDebugPrint("xHighLevelStarTrekDoor: Events = ", events[0][1].lstrip('DoorState='))
curState = int(events[0][1].lstrip('DoorState='))
PtDebugPrint("xHighLevelStarTrekDoor: Door State Updated to %d" % curState)
#PtDebugPrint("xHighLevelStarTrekDoor: Door State SDL Set to %d" % self.SDL['DoorState'][0])
if curState != self.DoorState:
self.DoorState = curState
PtDebugPrint("xHighLevelStarTrekDoor: Door state is now %d" % self.DoorState)
return


##########################################
elif id == rgnSensor.id:
if id == rgnSensor.id:
if self.DoorEnabled == 0:
return
#Region Triggered
for event in events:
#true when you enter the region

if event[0] == 1 and event[1] == 1 and PtFindAvatar(events) == PtGetLocalAvatar():
playerID = PtGetLocalPlayer().getPlayerID()
triggerstr = "rgnTriggerEnter%d" % playerID
self.SendNote(triggerstr)
PtDebugPrint("xHighLevelStarTrekDoor: Door region entered.")

if event[0] == 1 and event[1] == 1:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I wonder if there is a less tedious way to do this?

if doorState == doorSDLstates.closed:
self.UpdateDoorState(doorSDLstates.opening)
PtDebugPrint("xHighLevelStarTrekDoor: Setting Door to opening.")

elif doorState in (doorSDLstates.movingclosed, doorSDLstates.closing):
self.UpdateDoorState(doorSDLstates.closetoopen)
PtDebugPrint("xHighLevelStarTrekDoor: Setting Door to closetoopen.")

elif doorState == doorSDLstates.opentoclose:
self.UpdateDoorState(doorSDLstates.movingopen)
PtDebugPrint("xHighLevelStarTrekDoor: Setting Door to movingopen.")
return

#true when you leave the region
elif event[0] == 1 and event[1] == 0 and PtFindAvatar(events) == PtGetLocalAvatar():
playerID = PtGetLocalPlayer().getPlayerID()
triggerstr = "rgnTriggerExit%d" % playerID
self.SendNote(triggerstr)
PtDebugPrint("xHighLevelStarTrekDoor: Door region clear.")
elif event[0] == 1 and event[1] == 0:
if doorState == doorSDLstates.open:
self.UpdateDoorState(doorSDLstates.closing)
PtDebugPrint("xHighLevelStarTrekDoor: Setting Door to closing.")

elif doorState in (doorSDLstates.movingopen, doorSDLstates.opening):
self.UpdateDoorState(doorSDLstates.opentoclose)
PtDebugPrint("xHighLevelStarTrekDoor: Setting Door to opentoclose.")

elif doorState == doorSDLstates.closetoopen:
self.UpdateDoorState(doorSDLstates.movingclosed)
PtDebugPrint("xHighLevelStarTrekDoor: Setting Door to movingclosed.")
return


elif id == respOpenDoor.id:

self.UpdateRespStack()

PtDebugPrint("xHighLevelStarTrekDoor: Door is now open.")
if self.sceneobject.isLocallyOwned():
if self.DoorState == doorSDLstates['opentoclose']:
self.UpdateDoorState(doorSDLstates['closing'])

elif self.DoorState == doorSDLstates['movingopen'] or self.DoorState == doorSDLstates['opening']:
self.UpdateDoorState(doorSDLstates['open'])
if doorState == doorSDLstates.opentoclose:
self.UpdateDoorState(doorSDLstates.closing)

elif id == respCloseDoor.id:
elif doorState in (doorSDLstates.movingopen, doorSDLstates.opening):
self.UpdateDoorState(doorSDLstates.open)

self.UpdateRespStack()

elif id == respCloseDoor.id:
PtDebugPrint("xHighLevelStarTrekDoor: Door is now closed.")
if self.sceneobject.isLocallyOwned():
if self.DoorState == doorSDLstates['closetoopen']:
self.UpdateDoorState(doorSDLstates['opening'])

elif self.DoorState == doorSDLstates['movingclosed'] or self.DoorState == doorSDLstates['closing']:
self.UpdateDoorState(doorSDLstates['closed'])

##########################################
def SendNote(self, ExtraInfo):
notify = ptNotify(self.key)
notify.clearReceivers()
notify.addReceiver(self.key)
notify.netPropagate(1)
notify.netForce(1)
notify.setActivate(1.0)
notify.addVarNumber(str(ExtraInfo),1.0)
notify.send()
if doorState == doorSDLstates.closetoopen:
self.UpdateDoorState(doorSDLstates.opening)

##########################################
def UpdateRespStack (self):
#PtClearTimerCallbacks(self.key)
#Updates the Responder List
old = self.DoorStack.pop(0)
PtDebugPrint("xHighLevelStarTrekDoor: Getting rid of Resp: %s" % (old))
if len(self.DoorStack):
PtDebugPrint("xHighLevelStarTrekDoor: There's at lest one more Resp to play.")
code = self.DoorStack[0]
PtDebugPrint("Playing command: %s" % (code))
#PtDebugPrint("xHighLevelStarTrekDoor: Timer set to : %d" % self.respondertime)
#PtAtTimeCallback(self.key,self.respondertime,1)
self.ExecCode(code)
if self.DoorStack[0].find('fastforward=1') != -1:
self.DoorStack.pop(0)
elif doorState in (doorSDLstates.movingclosed, doorSDLstates.closing):
self.UpdateDoorState(doorSDLstates.closed)

##########################################
def UpdateDoorState (self, StateNum):
if StateNum != self.DoorState:
if StateNum != self.SDL['DoorState'][0]:
ageSDL = PtGetAgeSDL()
self.DoorState = StateNum
self.SDL['DoorState'] = (StateNum,)
self.SendNote('DoorState='+str(StateNum))
PtClearTimerCallbacks(self.key)
PtAtTimeCallback(self.key, 30, 1)
if self.DoorEnabled == 0:
return

if self.DoorState == doorSDLstates['opening']:
self.SendNote("respOpenDoor;0")
PtDebugPrint("xHighLevelStarTrekDoor: Notifying Clients to play Open Door Responder")

elif self.DoorState == doorSDLstates['closing']:
self.SendNote("respCloseDoor;0")
PtDebugPrint("xHighLevelStarTrekDoor: Notifying Clients to play Close Door Responder")

elif self.DoorState == doorSDLstates['open']:
PtDebugPrint("xHighLevelStarTrekDoor: Updating Age SDL to Open")
return
if self.SDL['DoorState'][0] == doorSDLstates.opening:
ageSDL[strDoorClosedVar.value] = (0,)

elif self.DoorState == doorSDLstates['closed']:
PtDebugPrint("xHighLevelStarTrekDoor: Updating Age SDL to Closed")
elif self.SDL['DoorState'][0] == doorSDLstates.closing:
ageSDL[strDoorClosedVar.value] = (1,)

##########################################
# This is a cheap hack to attempt to get
# the doors reset, should the age owner
# screw up and not update the door states
##########################################
def OnTimer(self,TimerID):
if self.sceneobject.isLocallyOwned():
PtDebugPrint("xHighLevelStarTrekDoor: Timer Came Back")
if self.DoorState == doorSDLstates['opentoclose']:
self.UpdateDoorState(doorSDLstates['closing'])

elif self.DoorState == doorSDLstates['movingopen'] or self.DoorState == doorSDLstates['opening']:
self.UpdateDoorState(doorSDLstates['open'])

elif self.DoorState == doorSDLstates['closetoopen']:
self.UpdateDoorState(doorSDLstates['opening'])

elif self.DoorState == doorSDLstates['movingclosed'] or self.DoorState == doorSDLstates['closing']:
self.UpdateDoorState(doorSDLstates['closed'])

def ExecCode(self,code):
try:
chunks = code.split(';')
tag = chunks[0];
fastForward = int(chunks[1])
if tag == "respOpenDoor":
if fastForward == 1:
respOpenDoor.run(self.key,fastforward=1)
else:
respOpenDoor.run(self.key,netPropagate=0)
elif tag == "respCloseDoor":
if fastForward == 1:
respCloseDoor.run(self.key,fastforward=1)
else:
respCloseDoor.run(self.key,netPropagate=0)
else:
PtDebugPrint("xHighLevelStarTrekDoor.ExecCode(): ERROR! Invalid tag '%s'." % (tag))
self.DoorStack.pop(0)
except:
PtDebugPrint("xStandardDoor.ExecCode(): ERROR! Invalid code '%s'." % (code))
self.DoorStack.pop(0)