Script v1.7.1.0
- AI
- Animals
- Contracts
- Debug
- Economy
- Effects
- Events
- Farms
- GUI
- Handtools
- I3d
- Materials
- Misc
- Objects
- Placeables
- Player
- Player
- PlayerModelManager
- PlayerPickUpObjectEvent
- PlayerSetFarmAnswerEvent
- PlayerSetFarmEvent
- PlayerSetHandToolEvent
- PlayerStateActivateObject
- PlayerStateAnimalFeed
- PlayerStateAnimalInteract
- PlayerStateAnimalPet
- PlayerStateAnimalRide
- PlayerStateBase
- PlayerStateCrouch
- PlayerStateCycleHandtool
- PlayerStateDrop
- PlayerStateFall
- PlayerStateIdle
- PlayerStateJump
- PlayerStateMachine
- PlayerStatePickup
- PlayerStateRun
- PlayerStateSwim
- PlayerStateThrow
- PlayerStateUseLight
- PlayerStateWalk
- PlayerStyle
- PlayerSwitchedFarmEvent
- PlayerTeleportEvent
- PlayerThrowObjectEvent
- PlayerToggleLightEvent
- Shop
- Sounds
- Specializations
- Triggers
- Utils
- Vehicles
- Weather
Engine v1.7.1.0
- AI
- Animation
- Camera
- Entity
- Fillplanes
- General
- I3D
- Input
- Lighting
- Math
- Network
- Node
- Overlays
- Particle System
- Physics
- Rendering
- Scenegraph
- Shape
- Sound
- Spline
- String
- Terrain Detail
- Text Rendering
- Tire Track
- XML
- general
Foundation Reference
PlayerStateSwim
ParentPlayerStateBaseFunctions
isAvailable
DescriptionCheck if state is available if player is in waterDefinition
isAvailable()Return Values
| bool | true | if player can swim |
| 29 | function PlayerStateSwim:isAvailable() |
| 30 | local isInWater = self.player.baseInformation.isInWater |
| 31 | |
| 32 | if isInWater then |
| 33 | return true |
| 34 | end |
| 35 | return false |
| 36 | end |
new
DescriptionCreating instance of state.Definition
new(table player, table stateMachine)Arguments
| table | player | instance of player |
| table | stateMachine | instance of the state machine manager |
| table | instance | instance of object |
| 20 | function PlayerStateSwim:new(player, stateMachine) |
| 21 | local self = PlayerStateBase:new(player, stateMachine, PlayerStateSwim_mt) |
| 22 | |
| 23 | return self |
| 24 | end |
update
DescriptionUpdate method. Will deactivate if player is not in water anymoreDefinition
update(float dt)Arguments
| float | dt | delta time in ms |
| 41 | function PlayerStateSwim:update(dt) |
| 42 | if not self.player.baseInformation.isInWater then |
| 43 | self:deactivate() |
| 44 | end |
| 45 | end |