LUADOC - Farming Simulator 19

TipEffect

Description
Copyright (C) GIANTS Software GmbH, Confidential, All Rights Reserved.
Parent
Effect
Functions

delete

Description
Definition
delete()
Code
28function TipEffect:delete()
29 for _, effect in ipairs(self.effects) do
30 effect:delete()
31 end
32end

isRunning

Description
Definition
isRunning()
Code
44function TipEffect:isRunning()
45 return self.activeEffect ~= nil and self.activeEffect:isRunning()
46end

load

Description
Definition
load()
Code
19function TipEffect:load(xmlFile, baseName, rootNodes, parent, i3dMapping)
20
21 self.effects = g_effectManager:loadEffect(xmlFile, baseName, rootNodes, parent, i3dMapping)
22
23 return self
24end

new

Description
Definition
new()
Code
9function TipEffect:new(customMt)
10 local self = Effect:new(customMt or TipEffect_mt)
11
12 self.activeEffect = nil
13
14 return self
15end

reset

Description
Definition
reset()
Code
70function TipEffect:reset()
71 for _, effect in ipairs(self.effects) do
72 effect:reset()
73 end
74end

setDistance

Description
Definition
setDistance()
Code
95function TipEffect:setDistance(distance)
96 if self.activeEffect ~= nil then
97 if self.activeEffect.setDistance ~= nil then
98 self.activeEffect:setDistance(distance)
99 end
100 end
101end

setFillType

Description
Definition
setFillType()
Code
78function TipEffect:setFillType(fillType, force)
79 local foundEffect = false
80 for _, effect in ipairs(self.effects) do
81 if effect.setFillType ~= nil then
82 if effect:setFillType(fillType, force) then
83 self.activeEffect = effect
84 foundEffect = true
85 break
86 end
87 end
88 end
89
90 return foundEffect
91end

start

Description
Definition
start()
Code
50function TipEffect:start()
51 if self.activeEffect ~= nil then
52 return self.activeEffect:start()
53 end
54
55 return false
56end

stop

Description
Definition
stop()
Code
60function TipEffect:stop()
61 if self.activeEffect ~= nil then
62 return self.activeEffect:stop()
63 end
64
65 return false
66end

update

Description
Definition
update()
Code
36function TipEffect:update(dt)
37 if self.activeEffect ~= nil then
38 self.activeEffect:update(dt)
39 end
40end