Skip to content

Latest commit

 

History

History
315 lines (253 loc) · 10.3 KB

INDEX.md

File metadata and controls

315 lines (253 loc) · 10.3 KB

Documentation

Table of Contents

Documentation files:

Add specialization to placeable type

<?xml version="1.0" encoding="utf-8" standalone="no"?>
<modDesc version="...">
    ...
    <placeableTypes>
        <!-- Extend parent type, can be anything -->
        <type name="mineShaft" parent="simplePlaceable" filename="$dataS/scripts/placeables/Placeable.lua">
            <specialization name="FS22_1_PlaceableMaterialSpawner.materialSpawner" />
        </type>
    </placeableTypes>
    ...
</modDesc>

Placeable XML

<?xml version="1.0" encoding="utf-8" standalone="no"?>
<placeable ...>
    ...
    <materialSpawner>
        <!-- Optional for enabling access to control panel GUI -->
        <activationTrigger node="..." />

        <spawnAreas>
            <!-- Define 1 or more spawn areas -->
            <spawnArea>
                <!-- Supports using l10n texts from your mod -->
                <name>$l10n_conveyor</name>
                <litersPerHour>4000</litersPerHour>
                
                <!-- By choice you can define multiple filltypes. -->
                <!-- In order to enable GUI to change output, activationTrigger needs to be added -->
                <fillTypes>STONE</fillTypes>
                <!--
                <fillTypes>STONE IRONORE</fillTypes>
                -->

                <area startNode=".." widthNode=".." heightNode=".." />

                <!-- Optional -->
                <effectNodes>
                    ...
                </effectNodes>

                <!-- Optional -->
                <animationNodes>
                    ...
                </animationNodes>

                <!-- Optional -->
                <sounds>
                    <work .. />
                    <work2 .. />
                    <dropping .. />
                </sounds>
            </spawnArea>

            ...
        </spawnAreas>
    </materialSpawner>
</placeable>

Activation trigger

placeable.materialSpawner.activationTrigger
Name Type Required Default Description
node node No

(Optional) Player activation trigger for openening the control panel GUI. This allows you to change materials if applicable and disable/enable each spawn area. The collisionMask of node must have bit 20 (TRIGGER_PLAYER) set in order for it to function.

<placeable>
    ...
    <materialSpawner>
        <activationTrigger node="playerControlPanelTriggerNode" />
        ...
    </materialSpawner>
    ...
</placeable>

SpawnArea

placeable.materialSpawner.spawnAreas.spawnArea(%)

<?xml version="1.0" encoding="utf-8" standalone="no"?>
<placeable>
    <materialSpawner>
        <activationTrigger node="playerControlPanelTriggerNode" />

        <spawnAreas>
            <spawnArea useProductionStorage="false" defaultEnabled="true">
                <name>$l10n_mySpawnArea</name>
                <litersPerHour>1000</litersPerHour>
                <fillTypes>STONE DIRT</fillTypes>

                ...
            </spawnArea>
        </spawnAreas>
    </materialSpawner>
</placeable>
Name Type Required Default Description
name string No Name to show in control panel GUI
fillTypes string Yes Name of fillType(s) separated by whitespace
litersPerHour int No 100 Liters per hour to spawn

Attributes

Name Type Required Default Description
defaultEnabled boolean No true Set default enabled for spawn area
useProductionStorage boolean No false If placeable has ProductionPoint specialization, pull material out from the storage

Area

placeable.materialSpawner.spawnAreas.spawnArea(%).area

(Required) Define area in which to spawn material.

<?xml version="1.0" encoding="utf-8" standalone="no"?>
<placeable>
    <materialSpawner>
        <activationTrigger node="playerControlPanelTriggerNode" />

        <spawnAreas>
            <spawnArea useProductionStorage="false" defaultEnabled="true">
                <name>$l10n_mySpawnArea</name>
                <litersPerHour>1000</litersPerHour>
                <fillTypes>STONE DIRT</fillTypes>

                <area startNode="spawnArea1Start" widthNode="spawnArea1Width" heightNode="spawnArea1Height" />
            </spawnArea>
        </spawnAreas>
    </materialSpawner>
</placeable>
Name Type Required Default Description
startNode node Yes
widthNode node Yes
heightNode node Yes

Sounds

placeable.materialSpawner.spawnAreas.spawnArea(%).sounds.work
placeable.materialSpawner.spawnAreas.spawnArea(%).sounds.work2
placeable.materialSpawner.spawnAreas.spawnArea(%).sounds.dropping

(Optional)

<?xml version="1.0" encoding="utf-8" standalone="no"?>
<placeable>
    <materialSpawner>
        <activationTrigger node="playerControlPanelTriggerNode" />

        <spawnAreas>
            <spawnArea useProductionStorage="false" defaultEnabled="true">
                <name>$l10n_mySpawnArea</name>
                <litersPerHour>1000</litersPerHour>
                <fillTypes>STONE DIRT</fillTypes>

                <area startNode="spawnArea1Start" widthNode="spawnArea1Width" heightNode="spawnArea1Height" />

                <sounds>
                    <work file="sounds/workSound1.wav" linkNode="soundNode" loops="0" innerRadius="7" outerRadius="30" supportsReverb="false">
                        <volume indoor="0.3" outdoor="2" />
                    </work>
                    <work2 file="sounds/workSound2.wav" linkNode="soundNode" loops="0" innerRadius="2" outerRadius="20" supportsReverb="false">
                        <volume indoor="0.3" outdoor="2" />
                    </work2>
                    <dropping file="sounds/discharge.wav" linkNode="spawnPositionSoundNode" loops="0" innerRadius="2" outerRadius="25" supportsReverb="false" pitchScale="1.0">
                        <volume indoor="0.5" outdoor="3.0" />
                    </dropping>
                </sounds>
            </spawnArea>
        </spawnAreas>
    </materialSpawner>
</placeable>

Uses the standard sample setup.

Effect nodes

placeable.materialSpawner.spawnAreas.spawnArea(%).effectNodes.effectNode(%)

(Optional)

<?xml version="1.0" encoding="utf-8" standalone="no"?>
<placeable>
    <materialSpawner>
        <activationTrigger node="playerControlPanelTriggerNode" />

        <spawnAreas>
            <spawnArea useProductionStorage="false" defaultEnabled="true">
                <name>$l10n_mySpawnArea</name>
                <litersPerHour>1000</litersPerHour>
                <fillTypes>STONE DIRT</fillTypes>

                <area startNode="spawnArea1Start" widthNode="spawnArea1Width" heightNode="spawnArea1Height" />

                <sounds>
                    <work file="sounds/workSound1.wav" linkNode="soundNode" loops="0" innerRadius="7" outerRadius="30" supportsReverb="false">
                        <volume indoor="0.3" outdoor="2" />
                    </work>
                    <work2 file="sounds/workSound2.wav" linkNode="soundNode" loops="0" innerRadius="2" outerRadius="20" supportsReverb="false">
                        <volume indoor="0.3" outdoor="2" />
                    </work2>
                    <dropping file="sounds/discharge.wav" linkNode="spawnPositionSoundNode" loops="0" innerRadius="2" outerRadius="25" supportsReverb="false" pitchScale="1.0">
                        <volume indoor="0.5" outdoor="3.0" />
                    </dropping>
                </sounds>

                <effectNodes>
                    <effectNode effectNode="effectSmoke" materialType="unloadingSmoke" fadeTime="0.5" />
                </effectNodes>
            </spawnArea>
        </spawnAreas>
    </materialSpawner>
</placeable>

Uses the standard effect nodes setup.

Animation nodes

placeable.materialSpawner.spawnAreas.spawnArea(%).animationNodes.animationNode(%)

(Optional)

<?xml version="1.0" encoding="utf-8" standalone="no"?>
<placeable>
    <materialSpawner>
        <activationTrigger node="playerControlPanelTriggerNode" />

        <spawnAreas>
            <spawnArea useProductionStorage="false" defaultEnabled="true">
                <name>$l10n_mySpawnArea</name>
                <litersPerHour>1000</litersPerHour>
                <fillTypes>STONE DIRT</fillTypes>

                <area startNode="spawnArea1Start" widthNode="spawnArea1Width" heightNode="spawnArea1Height" />

                <sounds>
                    <work file="sounds/workSound1.wav" linkNode="soundNode" loops="0" innerRadius="7" outerRadius="30" supportsReverb="false">
                        <volume indoor="0.3" outdoor="2" />
                    </work>
                    <work2 file="sounds/workSound2.wav" linkNode="soundNode" loops="0" innerRadius="2" outerRadius="20" supportsReverb="false">
                        <volume indoor="0.3" outdoor="2" />
                    </work2>
                    <dropping file="sounds/discharge.wav" linkNode="spawnPositionSoundNode" loops="0" innerRadius="2" outerRadius="25" supportsReverb="false" pitchScale="1.0">
                        <volume indoor="0.5" outdoor="3.0" />
                    </dropping>
                </sounds>

                <effectNodes>
                    <effectNode effectNode="effectSmoke" materialType="unloadingSmoke" fadeTime="0.5" />
                </effectNodes>

                <animationNodes>
                    <animationNode class="ScrollingAnimation" node="belt" rotSpeed="-25" rotAxis="1" shaderComponentScale="-1 0 0 0" scrollSpeed="0.5" shaderParameterName="offsetUV" />
                </animationNodes>
            </spawnArea>
        </spawnAreas>
    </materialSpawner>
</placeable>

Uses the standard animation nodes setup.