SlyMods

Sly 1:LOCKG: Difference between revisions

Sly 1 Discussion

Sly 1:LOCKG (view source)

Revision as of 20:34, 26 September 2023

193 bytes added ,  7 months ago
m
Fix typo
VisualWikitext
(Started struct fields table)
m (Fix typo)
 
(2 intermediate revisions by the same user not shown)
Line 1:
{{Infobox data structure
| image= File:Sly 1 SDC 3key unlocking.png
| sly1= y
| official= y
}}
Line 11:
The LOCKG struct has the following fields:
{{Struct top}}
{{Struct field|offset=|size=4|type=int|name=cpLockgrfws|description=NumberBitfield ofOR'd lockswith inthe grfws on the groupglobal {{Sly 1|GS}} struct when triggered}}
{{Struct field|offset=|size=324|type=LOCKstruct SMA*[8]|name=apLockpsma|description=ArrayThe SMA ofactivated lockwhen pointerstriggered}}
{{Struct field|offset=|size=4|type=struct SMASM*|name=smaGoalpsm|description=The'''Unknown''' SMASM goal to set upon opening the locks.pointer}}
{{Struct field||4|int|coidLock|Count of lock OIDs}}
{{Struct field||32|enum OID[8]|aoidLock|Array of lock OIDs}}
{{Struct field|offset=|size=4|type=int|name=cplock|description=Count of locks in the group}}
{{Struct field|offset=|size=32|type=LOCK*[8]|name=aplock|description=Array of lock pointers}}
{{Struct bottom}}
 
Line 20 ⟶ 24:
== Implementation ==
 
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 [[{{Sly 1:|KEY]]}} for each [[{{Sly 1:LOCK]]}} in the <code>apLockaplock</code> array. Each key flies to its assigned lock and then despawns.▼
[[File:Sly 1 SDC 3key unlocking.png|thumb|The cutscene after triggering a LOCKG in {{Sly 1|The Swamp's Dark Center}}]]
▲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 [[Sly 1:KEY]] for each [[Sly 1:LOCK]] in the <code>apLock</code> array. Each key flies to its assigned lock and then despawns.
 
At some point a message with ID 0xXXX{{check}} is sent to the [[{{Sly 1:JT|JT]]}} struct. This message is processed by <code>HandleJtMessage</code>, which checks if the <code>ckey</code> on the current {{Sly 1|WS|world state}} is greater than the <code>cpLockcppock</code>{{check}} on the LOCKG (i.e. it checks if you have enough keys to open the lock).
 
If the check passes, it uses the <code>LOCKG->FWS</code> as a bitmask to set the corresponding flag on the FWS of the current WS. It then unlocks the locks and sets the [[{{Sly 1:SMA|SmaGoal]]SMA}} based on the <code>LOCKG-> smaGoalsma</code> pointer. The SMA goal, is processed by {{Sly 1|Splice}} to trigger whatever scripted event happens as a result of the locks being unlocked.
 
Once all locks complete their unlock [[{{Sly 1:|ASEG|animation]]}}, the associated locks disappear from the world.
 
== Example ==
 
In Prowling the Grounds, the LOCKG which handles unlocking the cannon is based at address 0xXXXXXX{{check}}. It’s <code>cpLockcplock</code>{{check}} value is 7, meaning there are 7 locks in the <code>apLockaplock</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 seems to handle removing the lid from the cannon.
Line 37 ⟶ 40:
== Notes ==
 
* The <code>apLockaplock</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 softlocks.
 
{{Navbox Sly 1}}
Retrieved from "https://slymods.info/wiki/Special:MobileDiff/2885...2994"