Sly 1:LOCKG: Difference between revisions

'''LOCKG''' (likely short for '''Lock GoalG'''oal) is a data structure in {{Sly 1}} that handles interaction between Sly and obstaclestreasure locked with treasurekey keyslocks.

When the trigger volume associated with a LOCKG is triggered it sets off a sequence of events. It starts with the animation that spawns a [[KEY]] for each [[LOCK]] in the <code>apLock</code> array. TheseEach keyskey flyflies to theirits assigned lockslock and then despawndespawns.

At some point a message with ID 0xXXX{{check}} is sent to the [[JT (Sly 1)|JT]] struct. This message is processed by <code>HandleJtMessage</code>, which checks if the <code>ckey</code> on the current [[WS]] (World State) is greater than the <code>cpLock</code>{{check}} on the LOCKG (ie. it checks if you have enough keys to open the lock).

If the check passes, it uses the LOCKG’s FWS as a bit mask to set the corresponding flag on the currentFWS WS’of FWSthe current WS. It then unlocks the locks and sets the [[SMA]] goal based on the LOCKG’s <code>smaGoal</code> pointer. The SMA goal, which seems to be processed by [[Splice]], determines the outcome (ie. what happens as a result of the locks being opened).

Once all locks havecomplete aretheir unlockedunlock [[ASEG|animation]], they are removed from from the game world along with the LOCKG itself.{{check}}

=== Example ===

In Prowling the Grounds, the LOCKG which handles for unlocking the cannon is based at address 0xXXXXXX{{check}}. It’s <code>cpLock</code>{{check}} value is 7, meaning there are 7 locks in the <code>apLock</code> array, so when you approach the cannon, it checks if you have 7 keys.

If the check fails, nothing happens. If the check passes, it sets the SMA goal to 0xXXXXXX{{check}}, which apparentlyseems to handleshandle removing the lid from the cannon.

* The <code>apLock</code> field is an array of 8 LOCK pointers. You can change these to point to any other entity in the level and they key will fly to and delete that entity instead. If you use this method to delete JT, the cutscene can’t complete and the game soft lockssoftlocks.