HWPFormat.wiki
changeset 959 b167ea1e5563
parent 798 30c5f1ebd552
child 960 7d07934c1fee
equal deleted inserted replaced
958:4e4e81083786 959:b167ea1e5563
    49 The name of a sidecar HWP equals the name of the Lua script it serves as a “sidecar”, with the file name suffix replaced by “.hwp”. Sidecar HWPs must be in the same directory as the script.
    49 The name of a sidecar HWP equals the name of the Lua script it serves as a “sidecar”, with the file name suffix replaced by “.hwp”. Sidecar HWPs must be in the same directory as the script.
    50 
    50 
    51 Example: The sidecar HWP of the Lua script in `/Data/Missions/Training/MyAwesomeMission.lua` would be `Data/Missions/Training/MyAwesomeMission.hwp`.
    51 Example: The sidecar HWP of the Lua script in `/Data/Missions/Training/MyAwesomeMission.lua` would be `Data/Missions/Training/MyAwesomeMission.hwp`.
    52 
    52 
    53 Using sidecar HWPs is useful for Lua scripters who want to provide a few resources for your script but don’t want to force users to install them globally or to fiddle around with their user data directory. Especially if using the resources only really makes sense together with the script.
    53 Using sidecar HWPs is useful for Lua scripters who want to provide a few resources for your script but don’t want to force users to install them globally or to fiddle around with their user data directory. Especially if using the resources only really makes sense together with the script.
       
    54 
       
    55 === Limitations ===
       
    56 '''Important''': HWPs are ''not'' recursive! This means if you put a HWP inside another HWP, Hedgewars will only load the actual contents of the outermost HWP. The contents of the inner HWP are not loaded. This implies that there is currently no way (via HWP) to distribute a script with custom data. You have to ask users to just extract a normal Zip file with your script data instead.
       
    57 
       
    58 This is considered a bug, see https://issues.hedgewars.org/show_bug.cgi?id=174.
    54 
    59 
    55 === Order of precedence ===
    60 === Order of precedence ===
    56 
    61 
    57   # Sidecar HWPs
    62   # Sidecar HWPs
    58   # All HWPs
    63   # All HWPs