Placeable Hotspots Extension for Farming Simulator 25

Farming Simulator 25    Revision: FS25-01    Game Version: 1.4.0.0

About

Farming Simulator 25 placeable specialisation allowing custom map hotspot icons via filename or slice identification.

Usage

These scripts are free for use in any Farming Simulator 25 Map or Placeable mod for both Private and Public release.

Copying or removing any part of the code contained within these scripts for external use without written permission from GtX | Andy is prohibited.

Publishing

The publishing of these scripts when they are not included as part of a Map or Placeable mod is not permitted.

Adding these scripts as part of a Global script or standalone script mod is not required or permitted.

All links must return to this GitHub repository.

Modification / Converting

Only GtX | Andy is permitted to make modifications to this code including but not limited to bug fixes, enhancements or the addition of new features.

Converting this script or parts there of to other version of the Farming Simulator series is not permitted without written approval from GtX | Andy.

Versioning

All versioning is controlled by GtX | Andy and not by any other page, individual or company.

Documentation

The following information displays some of the required modDesc and placeable XML information.

<modDesc descVersion="94">
    <placeableTypes>
        <type name="mySimplePlaceable" parent="simplePlaceable" className="Placeable" filename="$dataS/scripts/placeables/Placeable.lua" >
            <specialization name="hotspotsExtension" />
        </type>
    </placeableTypes>

    <placeableSpecializations>
        <specialization name="hotspotsExtension" className="PlaceableHotspotsExtension" filename="scripts/PlaceableHotspotsExtension.lua"/>
    </placeableSpecializations>
</modDesc>

###Option 1: Using filename, imageUVs and imageResolution

<placeable type="mySimplePlaceable">
    <hotspots>
        <hotspot teleportNode="unloadTriggerMarker">
            <customType name="PARK" filename="hud/mapHotspot.dds" imageUVs="14 14 100 100" imageResolution="128 128" category="OTHER"/>
        </hotspot>
    </hotspots>
</placeable>

###Option 2: Using slice

     - Each slice must first be registered by script before using this feature and are intended for mod releases already making use of slices.

<placeable type="mySimplePlaceable">
    <hotspots>
        <hotspot teleportNode="unloadTriggerMarker">
            <customType name="PARK" sliceId="mapHotspots.contractDeadwood" category="OTHER"/>
        </hotspot>
    </hotspots>
</placeable>

Copyright

Copyright (c) 2022 GtX (Andy)