AttacherJointControl

AttacherJointControl

Description

Specialization to steplessly control the height of an attacherJoint

Functions

• actionEventAttacherJointControl
• actionEventAttacherJointControlSetPoint
• controlAttacherJoint
• controlAttacherJointHeight
• controlAttacherJointTilt
• getCanBeSelected
• getControlAttacherJointDirection
• getIsAttacherJointControlDampingAllowed
• getLoweringActionEventState
• initSpecialization
• loadInputAttacherJoint
• onDelete
• onLoad
• onPostAttach
• onPreDetach
• onReadStream
• onReadUpdateStream
• onRegisterActionEvents
• onUpdate
• onWriteStream
• onWriteUpdateStream
• prerequisitesPresent
• registerEventListeners
• registerFunctions
• registerLoweringActionEvent
• registerOverwrittenFunctions

actionEventAttacherJointControl

Description

Definition

actionEventAttacherJointControl()

Arguments

any	self
any	actionName
any	inputValue
any	callbackState
any	isAnalog

Code

function AttacherJointControl.actionEventAttacherJointControl( self , actionName, inputValue, callbackState, isAnalog)
    if math.abs(inputValue) > 0 then
        local spec = self.spec_attacherJointControl
        local control = spec.nameToControl[actionName]

        -- multiply by 0.025 to have to same speed as in fs17
        local changedAlpha = inputValue * control.mouseSpeedFactor * 0.025
        if control.invertAxis then
            changedAlpha = - changedAlpha
        end

        self:controlAttacherJoint(control, control.moveAlpha + changedAlpha, false )
        spec.heightTargetAlpha = - 1
    end
end

actionEventAttacherJointControlSetPoint

Description

Definition

actionEventAttacherJointControlSetPoint()

Arguments

any	self
any	actionName
any	inputValue
any	callbackState
any	isAnalog

Code

function AttacherJointControl.actionEventAttacherJointControlSetPoint( self , actionName, inputValue, callbackState, isAnalog)
    local spec = self.spec_attacherJointControl
    if spec.jointDesc ~ = nil then
        if self:getControlAttacherJointDirection() then
            spec.heightTargetAlpha = spec.jointDesc.lowerAlpha
        else
                spec.heightTargetAlpha = spec.jointDesc.upperAlpha
            end

            spec.nextHeightDampingUpdateTime = g_ time + spec.jointDesc.moveTime
        end
    end

controlAttacherJoint

Description

Updates attacher joint move alpha and update joint frame

Definition

controlAttacherJoint(table control, float moveAlpha, , )

Arguments

table	control	control
float	moveAlpha	move alpha
any	automaticControl
any	noEventSend

Code

function AttacherJointControl:controlAttacherJoint(control, moveAlpha, automaticControl, noEventSend)
    local spec = self.spec_attacherJointControl
    local jointDesc = spec.jointDesc

    if self.isServer and jointDesc ~ = nil then
        moveAlpha = control.func( self , moveAlpha)

        local attacherVehicle = self:getAttacherVehicle()
        attacherVehicle:updateAttacherJointRotation(jointDesc, self )
        if jointDesc.jointIndex ~ = 0 then
            setJointFrame(jointDesc.jointIndex, 0 , jointDesc.jointTransform)
        end
    end

    spec.lastMoveTime = g_ time

    if not automaticControl then
        spec.nextHeightDampingUpdateTime = g_ time + 100
        control.moveAlphaLastManual = control.moveAlpha
    end

    control.moveAlpha = math.min( math.max(moveAlpha, 0 ), 1 )

    if noEventSend = = nil or not noEventSend then
        if math.abs(control.moveAlphaSent - moveAlpha) > 1 / AttacherJointControl.ALPHA_MAX_VALUE then
            control.moveAlphaSent = moveAlpha

            if not self.isServer then
                self:raiseDirtyFlags(spec.dirtyFlagClient)
            else
                    self:raiseDirtyFlags(spec.dirtyFlagServer)
                end
            end
        else
                control.moveAlphaSent = moveAlpha
            end
        end

controlAttacherJointHeight

Description

Updates attacher joint height by given mve alpha value

Definition

controlAttacherJointHeight(float moveAlpha)

Arguments

float	moveAlpha	move alpha

Return Values

float	moveAlpha	limited move alpha

Code

function AttacherJointControl:controlAttacherJointHeight(moveAlpha)
    local spec = self.spec_attacherJointControl
    local jointDesc = spec.jointDesc

    if moveAlpha = = nil then
        moveAlpha = jointDesc.moveAlpha
    end

    moveAlpha = math.clamp(moveAlpha, jointDesc.upperAlpha, jointDesc.lowerAlpha)
    self:updateAttacherJointRotationNodes(jointDesc, moveAlpha)

    jointDesc.moveAlpha = moveAlpha
    self:updateAttacherJointRotation(jointDesc, self )

    spec.lastHeightAlpha = moveAlpha

    return moveAlpha
end

controlAttacherJointTilt

Description

Updates attacher joint tilt by given mve alpha value

Definition

controlAttacherJointTilt(float moveAlpha)

Arguments

float	moveAlpha	move alpha

Return Values

float	moveAlpha	limited move alpha

Code

function AttacherJointControl:controlAttacherJointTilt(moveAlpha)
    local spec = self.spec_attacherJointControl

    if moveAlpha = = nil then
        moveAlpha = 0.5
    end

    moveAlpha = math.clamp(moveAlpha, 0 , 1 )
    local angle = spec.maxTiltAngle * - (moveAlpha - 0.5 )

    spec.jointDesc.upperRotationOffset = spec.jointDesc.upperRotationOffsetBackup + angle
    spec.jointDesc.lowerRotationOffset = spec.jointDesc.lowerRotationOffsetBackup + angle

    return moveAlpha
end

getCanBeSelected

Description

Definition

getCanBeSelected()

Arguments

any	superFunc

Code

function AttacherJointControl:getCanBeSelected(superFunc)
    return true
end

getControlAttacherJointDirection

Description

Returns direction boolean for lifting and lowering the implement by button press

Definition

getControlAttacherJointDirection()

Return Values

any	direction	direction

Code

function AttacherJointControl:getControlAttacherJointDirection()
    local spec = self.spec_attacherJointControl
    if spec.heightTargetAlpha ~ = - 1 then
        return spec.heightTargetAlpha = = spec.jointDesc.upperAlpha
    end

    local lastAlpha = spec.heightController.moveAlpha
    return math.abs(lastAlpha - spec.jointDesc.lowerAlpha) > math.abs(lastAlpha - spec.jointDesc.upperAlpha)
end

getIsAttacherJointControlDampingAllowed

Description

Returns if damping is allowed

Definition

getIsAttacherJointControlDampingAllowed()

Return Values

any	allowed	allowed

Code

function AttacherJointControl:getIsAttacherJointControlDampingAllowed()
    local attacherVehicle = self:getAttacherVehicle()
    if attacherVehicle:getLastSpeed() < 0.5 then
        return false
    end

    if self.movingDirection < = 0 then
        return false
    end

    return true
end

getLoweringActionEventState

Description

Definition

getLoweringActionEventState()

Arguments

any	superFunc

Code

function AttacherJointControl:getLoweringActionEventState(superFunc)
    local spec = self.spec_attacherJointControl
    if spec.heightController then
        local showText = spec.jointDesc ~ = nil

        local text
        if showText then
            if self:getControlAttacherJointDirection() then
                text = string.format(g_i18n:getText( "action_lowerOBJECT" ), self.typeDesc)
            else
                    text = string.format(g_i18n:getText( "action_liftOBJECT" ), self.typeDesc)
                end
            end

            return showText, text
        end

        return superFunc( self )
    end

initSpecialization

Description

Definition

initSpecialization()

Code

function AttacherJointControl.initSpecialization()
    local schema = Vehicle.xmlSchema
    schema:setXMLSpecializationType( "AttacherJointControl" )

    schema:register(XMLValueType.ANGLE, "vehicle.attacherJointControl#maxTiltAngle" , "Max tilt angle" , 25 )
    schema:register(XMLValueType.BOOL, "vehicle.attacherJointControl#supportsDamping" , "Supports damping of Y axis" , false )
    schema:register(XMLValueType.FLOAT, "vehicle.attacherJointControl#dampingOffset" , "Distance from attacher joint to damping reference point(m)" , 2 )
    schema:register(XMLValueType.STRING, "vehicle.attacherJointControl.control(?)#controlFunction" , "Control script function (controlAttacherJointHeight or controlAttacherJointTilt)" )
        schema:register(XMLValueType.STRING, "vehicle.attacherJointControl.control(?)#controlAxis" , "Name of input action" )
        schema:register(XMLValueType.STRING, "vehicle.attacherJointControl.control(?)#iconName" , "Name of icon" )
        schema:registerAutoCompletionDataSource( "vehicle.attacherJointControl.control(?)#iconName" , "$dataS/axisIcons.xml" , "axisIcons.icon#name" )
        schema:register(XMLValueType.BOOL, "vehicle.attacherJointControl.control(?)#invertControlAxis" , "Invert control axis" , false )
        schema:register(XMLValueType.FLOAT, "vehicle.attacherJointControl.control(?)#mouseSpeedFactor" , "Mouse speed factor" , 1 )

        SoundManager.registerSampleXMLPaths(schema, "vehicle.attacherJointControl.sounds" , "hydraulic" )

        schema:register(XMLValueType.BOOL, Attachable.INPUT_ATTACHERJOINT_XML_KEY .. "#isControllable" , "Is controllable" , false )
        schema:register(XMLValueType.BOOL, Attachable.INPUT_ATTACHERJOINT_CONFIG_XML_KEY .. "#isControllable" , "Is controllable" , false )

        schema:setXMLSpecializationType()
    end

loadInputAttacherJoint

Description

Called on loading

Definition

loadInputAttacherJoint(table savegame, , , , )

Arguments

table	savegame	savegame
any	xmlFile
any	key
any	inputAttacherJoint
any	i

Code

function AttacherJointControl:loadInputAttacherJoint(superFunc, xmlFile, key, inputAttacherJoint, i)
    if not superFunc( self , xmlFile, key, inputAttacherJoint, i) then
        return false
    end

    inputAttacherJoint.isControllable = xmlFile:getValue(key .. "#isControllable" , false )

    return true
end

onDelete

Description

Definition

onDelete()

Code

function AttacherJointControl:onDelete()
    local spec = self.spec_attacherJointControl
    if self.isClient and spec.samples ~ = nil then
        g_soundManager:deleteSample(spec.samples.hydraulic)
    end
end

onLoad

Description

Called on loading

Definition

onLoad(table savegame)

Arguments

table	savegame	savegame

Code

function AttacherJointControl:onLoad(savegame)
    local spec = self.spec_attacherJointControl

    XMLUtil.checkDeprecatedXMLElements( self.xmlFile, "vehicle.attacherJointControl.control1" , "vehicle.attacherJointControl.control with #controlFunction 'controlAttacherJointHeight'" ) -- FS17
    XMLUtil.checkDeprecatedXMLElements( self.xmlFile, "vehicle.attacherJointControl.control2" , "vehicle.attacherJointControl.control with #controlFunction 'controlAttacherJointTilt'" ) -- FS17

    local baseKey = "vehicle.attacherJointControl"
    spec.maxTiltAngle = self.xmlFile:getValue(baseKey .. "#maxTiltAngle" , 25 )
    spec.heightTargetAlpha = - 1

    spec.supportsDamping = self.xmlFile:getValue(baseKey .. "#supportsDamping" , false )
    spec.dampingOffset = self.xmlFile:getValue(baseKey .. "#dampingOffset" , 2 )
    spec.nextHeightDampingUpdateTime = 0

    spec.controls = { }
    spec.nameToControl = { }
    local i = 0
    while true do
        local key = string.format( "%s.control(%d)" , baseKey, i)
        if not self.xmlFile:hasProperty(key) then
            break
        end

        local control = { }

        local controlFunc = self.xmlFile:getValue(key .. "#controlFunction" )
        if controlFunc ~ = nil and self [controlFunc] ~ = nil then
            control.func = self [controlFunc]

            if control.func = = self.controlAttacherJointHeight then
                spec.heightController = control
            end

            if control.func = = self.controlAttacherJointTilt then
                spec.tiltController = control
            end
        else
                Logging.xmlWarning( self.xmlFile, "Unknown control function '%s' for attacher joint control '%s'" , tostring(controlFunc), key)
                    break
                end

                local actionBindingName = self.xmlFile:getValue(key .. "#controlAxis" )
                if actionBindingName ~ = nil and InputAction[actionBindingName] ~ = nil then
                    control.controlAction = InputAction[actionBindingName]
                else
                        Logging.xmlWarning( self.xmlFile, "Unknown control axis '%s' for attacher joint control '%s'" , tostring(actionBindingName), key)
                            break
                        end

                        XMLUtil.checkDeprecatedXMLElements( self.xmlFile, key .. "#controlAxisIcon" , key .. "#iconName" ) --FS17 to FS19

                        local iconName = self.xmlFile:getValue(key .. "#iconName" , "" )
                        if InputHelpElement.AXIS_ICON[iconName] = = nil then
                            -- add the mod name as a prefix to match axis icon loading name collision avoidance
                            iconName = ( self.customEnvironment or "" ) .. iconName
                        end

                        control.axisActionIcon = iconName

                        control.invertAxis = self.xmlFile:getValue(key .. "#invertControlAxis" , false )
                        control.mouseSpeedFactor = self.xmlFile:getValue(key .. "#mouseSpeedFactor" , 1.0 )
                        control.moveAlpha = 0
                        control.moveAlphaSent = 0
                        control.moveAlphaLastManual = 0

                        spec.nameToControl[actionBindingName] = control
                        table.insert(spec.controls, control)

                        i = i + 1
                    end

                    if self.isClient then
                        spec.lastMoveTime = 0

                        spec.samples = { }
                        spec.samples.hydraulic = g_soundManager:loadSampleFromXML( self.xmlFile, baseKey .. ".sounds" , "hydraulic" , self.baseDirectory, self.components, 0 , AudioGroup.VEHICLE, self.i3dMappings, self )
                    end

                    spec.jointDesc = nil
                    spec.dirtyFlagClient = self:getNextDirtyFlag() -- client values changes, send to server
                    spec.dirtyFlagServer = self:getNextDirtyFlag() -- server data changed cause of damping, send to client

                    if #spec.controls = = 0 then
                        SpecializationUtil.removeEventListener( self , "onReadStream" , AttacherJointControl )
                        SpecializationUtil.removeEventListener( self , "onWriteStream" , AttacherJointControl )
                        SpecializationUtil.removeEventListener( self , "onReadUpdateStream" , AttacherJointControl )
                        SpecializationUtil.removeEventListener( self , "onWriteUpdateStream" , AttacherJointControl )
                        SpecializationUtil.removeEventListener( self , "onUpdate" , AttacherJointControl )
                        SpecializationUtil.removeEventListener( self , "onRegisterActionEvents" , AttacherJointControl )
                        SpecializationUtil.removeEventListener( self , "onPostAttach" , AttacherJointControl )
                        SpecializationUtil.removeEventListener( self , "onPreDetach" , AttacherJointControl )
                    end
                end

onPostAttach

Description

Called if vehicle gets attached

Definition

onPostAttach(table attacherVehicle, integer inputJointDescIndex, integer jointDescIndex, )

Arguments

table	attacherVehicle	attacher vehicle
integer	inputJointDescIndex	index of input attacher joint
integer	jointDescIndex	index of attacher joint it gets attached to
any	loadFromSavegame

Code

function AttacherJointControl:onPostAttach(attacherVehicle, inputJointDescIndex, jointDescIndex, loadFromSavegame)
    local spec = self.spec_attacherJointControl

    local inputAttacherJoints = self:getInputAttacherJoints()
    if inputAttacherJoints[inputJointDescIndex] ~ = nil and inputAttacherJoints[inputJointDescIndex].isControllable then
        local attacherJoints = attacherVehicle:getAttacherJoints()
        local jointDesc = attacherJoints[jointDescIndex]

        if jointDesc.upperAlpha = = jointDesc.lowerAlpha then
            return
        end

        if jointDesc.allowsLoweringBackup = = nil then
            jointDesc.allowsLoweringBackup = jointDesc.allowsLowering
        end
        jointDesc.allowsLowering = false
        jointDesc.upperRotationOffsetBackup = jointDesc.upperRotationOffset
        jointDesc.lowerRotationOffsetBackup = jointDesc.lowerRotationOffset

        spec.jointDesc = jointDesc

        -- reset control values
        for _, control in ipairs(spec.controls) do
            control.moveAlpha = control.func( self )
        end

        --lift after attach
        if loadFromSavegame then
            if spec.heightController ~ = nil then
                self:controlAttacherJoint(spec.heightController, spec.jointDesc.upperAlpha, false )
            end
        else
                spec.heightTargetAlpha = spec.jointDesc.upperAlpha
            end

            self:requestActionEventUpdate()
        end
    end

onPreDetach

Description

Called if vehicle gets detached

Definition

onPreDetach(table attacherVehicle, table implement)

Arguments

table	attacherVehicle	attacher vehicle
table	implement	implement

Code

function AttacherJointControl:onPreDetach(attacherVehicle, implement)
    local spec = self.spec_attacherJointControl

    if spec.jointDesc ~ = nil then
        spec.jointDesc.allowsLowering = spec.jointDesc.allowsLoweringBackup
        spec.jointDesc.upperRotationOffset = spec.jointDesc.upperRotationOffsetBackup
        spec.jointDesc.lowerRotationOffset = spec.jointDesc.lowerRotationOffsetBackup
        spec.jointDesc = nil
    end
end

onReadStream

Description

Called on client side on join

Definition

onReadStream(integer streamId, Connection connection)

Arguments

integer	streamId	streamId
Connection	connection	connection

Code

function AttacherJointControl:onReadStream(streamId, connection)
    if connection:getIsServer() then
        if streamReadBool(streamId) then
            local spec = self.spec_attacherJointControl
            for _, control in ipairs(spec.controls) do
                local moveAlpha = streamReadUIntN(streamId, AttacherJointControl.ALPHA_NUM_BITS) / AttacherJointControl.ALPHA_MAX_VALUE
                self:controlAttacherJoint(control, moveAlpha, false , true )
            end
        end
    end
end

onReadUpdateStream

Description

Called on on update

Definition

onReadUpdateStream(integer streamId, integer timestamp, table connection)

Arguments

integer	streamId	stream ID
integer	timestamp	timestamp
table	connection	connection

Code

function AttacherJointControl:onReadUpdateStream(streamId, timestamp, connection)
    local spec = self.spec_attacherJointControl
    if not connection:getIsServer() then
        if streamReadBool(streamId) then
            for _, control in ipairs(spec.controls) do
                local moveAlpha = streamReadUIntN(streamId, AttacherJointControl.ALPHA_NUM_BITS) / AttacherJointControl.ALPHA_MAX_VALUE
                self:controlAttacherJoint(control, moveAlpha, false , true )
            end
        end
    else
            if streamReadBool(streamId) then
                for _, control in ipairs(spec.controls) do
                    local moveAlpha = streamReadUIntN(streamId, AttacherJointControl.ALPHA_NUM_BITS) / AttacherJointControl.ALPHA_MAX_VALUE
                    self:controlAttacherJoint(control, moveAlpha, false , true )
                end
            end
        end
    end

onRegisterActionEvents

Description

Definition

onRegisterActionEvents()

Arguments

any	isActiveForInput
any	isActiveForInputIgnoreSelection

Code

function AttacherJointControl:onRegisterActionEvents(isActiveForInput, isActiveForInputIgnoreSelection)
    if self.isClient then
        local spec = self.spec_attacherJointControl
        self:clearActionEventsTable(spec.actionEvents)

        if isActiveForInputIgnoreSelection then
            if spec.jointDesc ~ = nil then
                for _, control in ipairs(spec.controls) do
                    local _, actionEventId = self:addPoweredActionEvent(spec.actionEvents, control.controlAction, self , AttacherJointControl.actionEventAttacherJointControl, false , false , true , true , nil , control.axisActionIcon)
                    g_inputBinding:setActionEventTextPriority(actionEventId, GS_PRIO_NORMAL)
                end
            end
        end
    end
end

onUpdate

Description

Called on update

Definition

onUpdate(float dt, boolean isActiveForInput, boolean isSelected, )

Arguments

float	dt	time since last call in ms
boolean	isActiveForInput	true if vehicle is active for input
boolean	isSelected	true if vehicle is selected
any	isSelected

Code

function AttacherJointControl:onUpdate(dt, isActiveForInput, isActiveForInputIgnoreSelection, isSelected)
    local spec = self.spec_attacherJointControl
    local control = spec.heightController

    --update attacher joint height by target alpha
    if control ~ = nil then
        if spec.jointDesc ~ = nil then
            if spec.heightTargetAlpha ~ = - 1 then
                local diff = spec.heightTargetAlpha - control.moveAlpha + 0.0001
                local moveTime = diff / (spec.jointDesc.upperAlpha - spec.jointDesc.lowerAlpha) * spec.jointDesc.moveTime
                local moveStep = dt / moveTime * diff
                if diff > 0 then
                    moveStep = - moveStep
                end
                local newAlpha = control.moveAlpha + moveStep
                self:controlAttacherJoint(control, newAlpha, spec.nextHeightDampingUpdateTime < g_ time , true )
                if math.abs(spec.heightTargetAlpha - newAlpha) < 0.01 then
                    spec.heightTargetAlpha = - 1
                end
            end

            if self.isServer then
                if spec.supportsDamping then
                    -- y axis damping
                    if spec.nextHeightDampingUpdateTime < g_ time then
                        local inputJointDesc = self:getActiveInputAttacherJoint()

                        local delta = 0
                        if self:getIsAttacherJointControlDampingAllowed() then
                            local wX, wY, wZ = getWorldTranslation(inputJointDesc.node)
                            local dirX, _, dirZ = localDirectionToWorld(inputJointDesc.node, spec.dampingOffset, 0 , 0 )
                            local posX, posY, posZ = worldToLocal( self.components[ 1 ].node, wX + dirX, wY, wZ + dirZ)
                            local _, vy, _ = getVelocityAtLocalPos( self.components[ 1 ].node, posX, posY, posZ)

                            --#debug DebugGizmo.renderAtPosition(wX+dirX, wY, wZ+dirZ, 0, 1, 0, 1, 0, 0, string.format("vy = %.2f(diff %.2f)", vy, control.moveAlphaLastManual - control.moveAlpha))

                            if math.abs(vy) > 0.15 then
                                delta = vy * 0.5
                            end
                        else
                                delta = control.moveAlphaLastManual - control.moveAlpha
                            end

                            delta = delta + (control.moveAlphaLastManual - control.moveAlpha) * 0.001 * dt

                            if math.abs(delta) > 0.0001 then
                                spec.heightTargetAlpha = math.clamp(control.moveAlpha + delta, 0 , 1 )
                                if spec.heightTargetAlpha < = 0 then
                                    if spec.tiltController ~ = nil then
                                        self:controlAttacherJoint(spec.tiltController, math.clamp(spec.tiltController.moveAlpha - delta * 0.1 , 0 , 1 ), true )
                                    end
                                end
                            end
                        end
                    end
                end
            end
        end

        if spec.lastMoveTime + 100 > g_ time then
            if not g_soundManager:getIsSamplePlaying(spec.samples.hydraulic) then
                g_soundManager:playSample(spec.samples.hydraulic)
            end
        else
                if g_soundManager:getIsSamplePlaying(spec.samples.hydraulic) then
                    g_soundManager:stopSample(spec.samples.hydraulic)
                end
            end
        end

onWriteStream

Description

Called on server side on join

Definition

onWriteStream(integer streamId, Connection connection)

Arguments

integer	streamId	streamId
Connection	connection	connection

Code

function AttacherJointControl:onWriteStream(streamId, connection)
    if not connection:getIsServer() then
        local spec = self.spec_attacherJointControl
        if streamWriteBool(streamId, spec.jointDesc ~ = nil ) then
            for _, control in ipairs(spec.controls) do
                streamWriteUIntN(streamId, control.moveAlpha * AttacherJointControl.ALPHA_MAX_VALUE, AttacherJointControl.ALPHA_NUM_BITS)
            end
        end
    end
end

onWriteUpdateStream

Description

Called on on update

Definition

onWriteUpdateStream(integer streamId, table connection, integer dirtyMask)

Arguments

integer	streamId	stream ID
table	connection	connection
integer	dirtyMask	dirty mask

Code

function AttacherJointControl:onWriteUpdateStream(streamId, connection, dirtyMask)
    local spec = self.spec_attacherJointControl
    if connection:getIsServer() then
        if streamWriteBool(streamId, bit32.band(dirtyMask, spec.dirtyFlagClient) ~ = 0 ) then
            for _, control in ipairs(spec.controls) do
                streamWriteUIntN(streamId, control.moveAlpha * AttacherJointControl.ALPHA_MAX_VALUE, AttacherJointControl.ALPHA_NUM_BITS)
            end
        end
    else
            if streamWriteBool(streamId, bit32.band(dirtyMask, spec.dirtyFlagServer) ~ = 0 ) then
                for _, control in ipairs(spec.controls) do
                    streamWriteUIntN(streamId, control.moveAlpha * AttacherJointControl.ALPHA_MAX_VALUE, AttacherJointControl.ALPHA_NUM_BITS)
                end
            end
        end
    end

prerequisitesPresent

Description

Checks if all prerequisite specializations are loaded

Definition

prerequisitesPresent(table specializations)

Arguments

table	specializations	specializations

Return Values

table	hasPrerequisite	true if all prerequisite specializations are loaded

Code

function AttacherJointControl.prerequisitesPresent(specializations)
    return SpecializationUtil.hasSpecialization( Attachable , specializations)
end

registerEventListeners

Description

Definition

registerEventListeners()

Arguments

any	vehicleType

Code

function AttacherJointControl.registerEventListeners(vehicleType)
    SpecializationUtil.registerEventListener(vehicleType, "onLoad" , AttacherJointControl )
    SpecializationUtil.registerEventListener(vehicleType, "onDelete" , AttacherJointControl )
    SpecializationUtil.registerEventListener(vehicleType, "onReadStream" , AttacherJointControl )
    SpecializationUtil.registerEventListener(vehicleType, "onWriteStream" , AttacherJointControl )
    SpecializationUtil.registerEventListener(vehicleType, "onReadUpdateStream" , AttacherJointControl )
    SpecializationUtil.registerEventListener(vehicleType, "onWriteUpdateStream" , AttacherJointControl )
    SpecializationUtil.registerEventListener(vehicleType, "onUpdate" , AttacherJointControl )
    SpecializationUtil.registerEventListener(vehicleType, "onRegisterActionEvents" , AttacherJointControl )
    SpecializationUtil.registerEventListener(vehicleType, "onPostAttach" , AttacherJointControl )
    SpecializationUtil.registerEventListener(vehicleType, "onPreDetach" , AttacherJointControl )
end

registerFunctions

Description

Definition

registerFunctions()

Arguments

any	vehicleType

Code

function AttacherJointControl.registerFunctions(vehicleType)
    SpecializationUtil.registerFunction(vehicleType, "controlAttacherJoint" , AttacherJointControl.controlAttacherJoint)
    SpecializationUtil.registerFunction(vehicleType, "controlAttacherJointHeight" , AttacherJointControl.controlAttacherJointHeight)
    SpecializationUtil.registerFunction(vehicleType, "controlAttacherJointTilt" , AttacherJointControl.controlAttacherJointTilt)
    SpecializationUtil.registerFunction(vehicleType, "getControlAttacherJointDirection" , AttacherJointControl.getControlAttacherJointDirection)
    SpecializationUtil.registerFunction(vehicleType, "getIsAttacherJointControlDampingAllowed" , AttacherJointControl.getIsAttacherJointControlDampingAllowed)
end

registerLoweringActionEvent

Description

Definition

registerLoweringActionEvent()

Arguments

any	superFunc
any	actionEventsTable
any	inputAction
any	target
any	callback
any	triggerUp
any	triggerDown
any	triggerAlways
any	startActive
any	callbackState
any	customIconName

Code

function AttacherJointControl:registerLoweringActionEvent(superFunc, actionEventsTable, inputAction, target, callback, triggerUp, triggerDown, triggerAlways, startActive, callbackState, customIconName)
    local spec = self.spec_attacherJointControl
    if spec.heightController then
        local _, actionEventId = self:addPoweredActionEvent(actionEventsTable, InputAction.LOWER_IMPLEMENT, self , AttacherJointControl.actionEventAttacherJointControlSetPoint, triggerUp, triggerDown, triggerAlways, startActive, callbackState, customIconName)
        g_inputBinding:setActionEventTextPriority(actionEventId, GS_PRIO_HIGH)

        if inputAction = = InputAction.LOWER_IMPLEMENT then
            return
        end
    end

    superFunc( self , actionEventsTable, inputAction, target, callback, triggerUp, triggerDown, triggerAlways, startActive, callbackState, customIconName)
end

registerOverwrittenFunctions

Description

Definition

registerOverwrittenFunctions()

Arguments

any	vehicleType

Code

function AttacherJointControl.registerOverwrittenFunctions(vehicleType)
    SpecializationUtil.registerOverwrittenFunction(vehicleType, "loadInputAttacherJoint" , AttacherJointControl.loadInputAttacherJoint)
    SpecializationUtil.registerOverwrittenFunction(vehicleType, "registerLoweringActionEvent" , AttacherJointControl.registerLoweringActionEvent)
    SpecializationUtil.registerOverwrittenFunction(vehicleType, "getLoweringActionEventState" , AttacherJointControl.getLoweringActionEventState)
    SpecializationUtil.registerOverwrittenFunction(vehicleType, "getCanBeSelected" , AttacherJointControl.getCanBeSelected)
end