Script v1_7_1_0
- AI
- Animals
- Collections
- Contracts
- Debug
- Economy
- Elements
- EnvironmentalScore
- Errors
- Events
- GUI
- Handtools
- Hud
- I3d
- Input
- Jobs
- Maps
- Materials
- Misc
- Objects
- Parameters
- Placeables
- Placement
- Player
- Shop
- Sounds
- Specialization
- Specializations
- StateMachine
- Statistics
- Tasks
- Triggers
- Utils
- Vehicles
Engine v1_7_1_0
- AI
- Animation
- Camera
- Entity
- Fillplanes
- general
- General
- I3D
- Input
- Lighting
- Math
- Network
- Node
- NoteNode
- Overlays
- Particle System
- Physics
- Rendering
- Scenegraph
- Shape
- Sound
- Spline
- String
- Terrain Detail
- Text Rendering
- Tire Track
- VoiceChat
- XML
Foundation Reference
PlaceableInfoTrigger
DescriptionSpecialization for placeablesFunctions
- onDelete
- onDraw
- onFinalizePlacement
- onInfoTriggerCallback
- onLoad
- prerequisitesPresent
- registerEventListeners
- registerEvents
- registerFunctions
- registerXMLPaths
- updateInfo
onDelete
DescriptionDefinitiononDelete()Code
75 | function PlaceableInfoTrigger:onDelete() |
76 | local spec = self.spec_infoTrigger |
77 | |
78 | if spec.infoTrigger ~= nil then |
79 | removeTrigger(spec.infoTrigger) |
80 | spec.infoTrigger = nil |
81 | end |
82 | |
83 | spec.showInfo = false |
84 | g_currentMission:removeDrawable(self) |
85 | |
86 | if spec.hudBox ~= nil then |
87 | g_currentMission.hud.infoDisplay:destroyBox(spec.hudBox) |
88 | end |
89 | end |
onDraw
DescriptionDefinitiononDraw()Code
102 | function PlaceableInfoTrigger:onDraw() |
103 | local spec = self.spec_infoTrigger |
104 | if spec.showInfo then |
105 | if spec.showAllPlayers or self:getOwnerFarmId() == g_currentMission:getFarmId() then |
106 | -- Gather info |
107 | self:updateInfo(spec.info) |
108 | |
109 | if #spec.info > 0 then |
110 | local box = spec.hudBox |
111 | box:clear() |
112 | box:setTitle(self:getName()) |
113 | |
114 | for i = 1, #spec.info do |
115 | local element = spec.info[i] |
116 | |
117 | box:addLine(element.title, element.text, element.accentuate) |
118 | |
119 | spec.info[i] = nil |
120 | end |
121 | |
122 | box:showNextFrame() |
123 | end |
124 | end |
125 | end |
126 | end |
onFinalizePlacement
DescriptionDefinitiononFinalizePlacement()Code
93 | function PlaceableInfoTrigger:onFinalizePlacement() |
94 | local spec = self.spec_infoTrigger |
95 | if spec.infoTrigger ~= nil then |
96 | addTrigger(spec.infoTrigger, "onInfoTriggerCallback", self) |
97 | end |
98 | end |
onInfoTriggerCallback
DescriptionDefinitiononInfoTriggerCallback()Code
130 | function PlaceableInfoTrigger:onInfoTriggerCallback(triggerId, otherId, onEnter, onLeave, onStay) |
131 | local spec = self.spec_infoTrigger |
132 | if g_currentMission.player ~= nil and otherId == g_currentMission.player.rootNode then |
133 | if onEnter then |
134 | spec.showInfo = true |
135 | g_currentMission:addDrawable(self) |
136 | SpecializationUtil.raiseEvent(self, "onInfoTriggerEnter", otherId) |
137 | |
138 | else |
139 | spec.showInfo = false |
140 | g_currentMission:removeDrawable(self) |
141 | SpecializationUtil.raiseEvent(self, "onInfoTriggerLeave", otherId) |
142 | end |
143 | end |
144 | end |
onLoad
DescriptionCalled on loadingDefinition
onLoad(table savegame)Arguments
table | savegame | savegame |
57 | function PlaceableInfoTrigger:onLoad(savegame) |
58 | local spec = self.spec_infoTrigger |
59 | |
60 | spec.info = {} |
61 | spec.showInfo = false |
62 | spec.showAllPlayers = self.xmlFile:getValue("placeable.infoTrigger#showAllPlayers", false) |
63 | spec.infoTrigger = self.xmlFile:getValue("placeable.infoTrigger#triggerNode", nil, self.components, self.i3dMappings) |
64 | if spec.infoTrigger ~= nil then |
65 | if not CollisionFlag.getHasFlagSet(spec.infoTrigger, CollisionFlag.TRIGGER_PLAYER) then |
66 | Logging.xmlWarning(self.xmlFile, "Info trigger collison mask is missing bit 'TRIGGER_PLAYER' (%d)", CollisionFlag.getBit(CollisionFlag.TRIGGER_PLAYER)) |
67 | end |
68 | end |
69 | |
70 | spec.hudBox = g_currentMission.hud.infoDisplay:createBox(KeyValueInfoHUDBox) |
71 | end |
prerequisitesPresent
DescriptionChecks if all prerequisite specializations are loadedDefinition
prerequisitesPresent(table specializations)Arguments
table | specializations | specializations |
boolean | hasPrerequisite | true if all prerequisite specializations are loaded |
18 | function PlaceableInfoTrigger.prerequisitesPresent(specializations) |
19 | return true |
20 | end |
registerEventListeners
DescriptionDefinitionregisterEventListeners()Code
31 | function PlaceableInfoTrigger.registerEventListeners(placeableType) |
32 | SpecializationUtil.registerEventListener(placeableType, "onLoad", PlaceableInfoTrigger) |
33 | SpecializationUtil.registerEventListener(placeableType, "onDelete", PlaceableInfoTrigger) |
34 | SpecializationUtil.registerEventListener(placeableType, "onFinalizePlacement", PlaceableInfoTrigger) |
35 | SpecializationUtil.registerEventListener(placeableType, "onDraw", PlaceableInfoTrigger) |
36 | end |
registerEvents
DescriptionDefinitionregisterEvents()Code
24 | function PlaceableInfoTrigger.registerEvents(placeableType) |
25 | SpecializationUtil.registerEvent(placeableType, "onInfoTriggerEnter") |
26 | SpecializationUtil.registerEvent(placeableType, "onInfoTriggerLeave") |
27 | end |
registerFunctions
DescriptionDefinitionregisterFunctions()Code
40 | function PlaceableInfoTrigger.registerFunctions(placeableType) |
41 | SpecializationUtil.registerFunction(placeableType, "updateInfo", PlaceableInfoTrigger.updateInfo) |
42 | SpecializationUtil.registerFunction(placeableType, "onInfoTriggerCallback", PlaceableInfoTrigger.onInfoTriggerCallback) |
43 | end |
registerXMLPaths
DescriptionDefinitionregisterXMLPaths()Code
47 | function PlaceableInfoTrigger.registerXMLPaths(schema, basePath) |
48 | schema:setXMLSpecializationType("InfoTrigger") |
49 | schema:register(XMLValueType.NODE_INDEX, basePath .. ".infoTrigger#triggerNode", "Info trigger", nil, false) |
50 | schema:register(XMLValueType.BOOL, basePath .. ".infoTrigger#showAllPlayers", "Show info to all players", false, false) |
51 | schema:setXMLSpecializationType() |
52 | end |
updateInfo
DescriptionDefinitionupdateInfo()Code
148 | function PlaceableInfoTrigger:updateInfo(info) |
149 | end |