Slothman/Slothbot: Difference between revisions
No edit summary |
(Formatting fiddling) |
||
| Line 1: | Line 1: | ||
This is a resource designed to allow scripts or gamemodes to insert a ped into the game that roughly simulates combat with a real player. gamemodes can implement the bots as opponents to actual players or as teammates. | This is a resource designed to allow scripts or gamemodes to insert a ped into the game that roughly simulates combat with a real player. gamemodes can implement the bots as opponents to actual players or as teammates. | ||
= | =Features= | ||
'''Teamplay:''' | '''Teamplay:''' | ||
The bot is capable of identifying friend from foe | The bot is capable of identifying friend from foe | ||
| Line 31: | Line 30: | ||
Integrated into the map editor, map designers can easily place paths for bots to follow along in their maps. this greatly increased the bots ability to simulate true playing. | Integrated into the map editor, map designers can easily place paths for bots to follow along in their maps. this greatly increased the bots ability to simulate true playing. | ||
= | =Server Events= | ||
==onBotFindEnemy== | |||
This triggers when a bot locates an enemy, This event can be cancelled to prevent the bot from chasing players | This triggers when a bot locates an enemy, This event can be cancelled to prevent the bot from chasing players | ||
| Line 42: | Line 41: | ||
*'''enemy''': The Player or Ped the bot has spotted | *'''enemy''': The Player or Ped the bot has spotted | ||
<big>'''Source'''</big> | <big>'''Source'''</big> | ||
The [[event system#Event source|source]] of this event is the Bot that has found an enemy | The [[event system#Event source|source]] of this event is the Bot that has found an enemy | ||
==onBotWasted== | |||
This triggers when a bot is killed. | This triggers when a bot is killed. | ||
| Line 57: | Line 55: | ||
*'''bodypart''': The bodypart id that was hit to kill the bot | *'''bodypart''': The bodypart id that was hit to kill the bot | ||
<big>'''Source'''</big> | <big>'''Source'''</big> | ||
The [[event system#Event source|source]] of this event is the Bot that died | The [[event system#Event source|source]] of this event is the Bot that died | ||
==onBotSpawned== | |||
This triggers when a bot is spawned. | This triggers when a bot is spawned. | ||
| Line 67: | Line 64: | ||
The [[event system#Event source|source]] of this event is the Bot that spawned | The [[event system#Event source|source]] of this event is the Bot that spawned | ||
==onBotFollow== | |||
This triggers when a bot starts following a teammate | This triggers when a bot starts following a teammate | ||
| Line 78: | Line 73: | ||
*'''leader''': The Player or Ped the bot has started following | *'''leader''': The Player or Ped the bot has started following | ||
<big>'''Source'''</big> | <big>'''Source'''</big> | ||
The [[event system#Event source|source]] of this event is the Bot that starts following a teammate | The [[event system#Event source|source]] of this event is the Bot that starts following a teammate | ||
=Server Functions= | |||
All of these funtions will have to be used through the [[call]] function, otherwise they won't work | All of these funtions will have to be used through the [[call]] function, otherwise they won't work | ||
==spawnBot== | |||
This function spawns a bot ingame | This function spawns a bot ingame | ||
| Line 106: | Line 101: | ||
*'''theModeSubject:''' if theMode is "chasing" or "hunting" this arg is needed to tell the bot what opponent to chase or teammate to follow | *'''theModeSubject:''' if theMode is "chasing" or "hunting" this arg is needed to tell the bot what opponent to chase or teammate to follow | ||
==setBotHunt== | |||
makes the bot travel pathways untill finding an enemy or teammate | makes the bot travel pathways untill finding an enemy or teammate | ||
<big>'''Syntax'''</big> | <big>'''Syntax'''</big> | ||
| Line 119: | Line 112: | ||
*'''theBot:''' The bot you want to hunt | *'''theBot:''' The bot you want to hunt | ||
==setBotWait== | |||
makes the bot stand still untill an enemy of teammate comes into view | makes the bot stand still untill an enemy of teammate comes into view | ||
| Line 132: | Line 123: | ||
*'''theBot:''' The bot you want to wait | *'''theBot:''' The bot you want to wait | ||
==setBotChase== | |||
makes the bot attack an anemy bot or player | makes the bot attack an anemy bot or player | ||
| Line 146: | Line 135: | ||
*'''theTarget:''' The bot or player you want to be chased | *'''theTarget:''' The bot or player you want to be chased | ||
==setBotFollow== | |||
makes the bot follow a teammate bot or player | makes the bot follow a teammate bot or player | ||
| Line 160: | Line 147: | ||
*'''theTarget:''' The bot or player you want to be followed | *'''theTarget:''' The bot or player you want to be followed | ||
==setBotGuard== | |||
makes the bot move to the specific coords and stay there while attacking any enemies | makes the bot move to the specific coords and stay there while attacking any enemies | ||
| Line 179: | Line 164: | ||
*'''priority:''' Set to true only if you want the bot to only shoot once it has reached the location to guard | *'''priority:''' Set to true only if you want the bot to only shoot once it has reached the location to guard | ||
==getBotTeam== | |||
returns the Team the bot is on, false if no team | returns the Team the bot is on, false if no team | ||
| Line 192: | Line 175: | ||
*'''theBot:''' The bot you want to check the team of | *'''theBot:''' The bot you want to check the team of | ||
==setBotTeam== | |||
changes the bot's team and loyalties | changes the bot's team and loyalties | ||
| Line 206: | Line 187: | ||
*'''theTeam:''' The team the bot should join | *'''theTeam:''' The team the bot should join | ||
==getBotAttackEnabled== | |||
returns true if the bot is allowed to attack, false otherwise | returns true if the bot is allowed to attack, false otherwise | ||
| Line 219: | Line 198: | ||
*'''theBot:''' The bot you want to check if it can atack | *'''theBot:''' The bot you want to check if it can atack | ||
==setBotAttackEnabled== | |||
allow or disallow the bot to attack (press fire) | allow or disallow the bot to attack (press fire) | ||
| Line 233: | Line 210: | ||
*'''enabled:''' set to false to remove the bots ability to attack, true to allow it | *'''enabled:''' set to false to remove the bots ability to attack, true to allow it | ||
==getBotMode== | |||
returns the mode the bot is in ("chasing", "waiting", "guarding", "hunting", "following") or if the bot is chasing or following, it will return the mode and the target | returns the mode the bot is in ("chasing", "waiting", "guarding", "hunting", "following") or if the bot is chasing or following, it will return the mode and the target | ||
| Line 246: | Line 221: | ||
*'''theBot:''' The bot you want to check the status of | *'''theBot:''' The bot you want to check the status of | ||
==isPedBot== | |||
returns true if the ped is a bot, false otherwise | returns true if the ped is a bot, false otherwise | ||
| Line 259: | Line 232: | ||
*'''thePed:''' The ped you want to check if its a bot | *'''thePed:''' The ped you want to check if its a bot | ||
==setBotWeapon== | |||
allow or disallow the bot to attack (press fire) | allow or disallow the bot to attack (press fire) | ||
| Line 273: | Line 244: | ||
*'''weapon:''' the weapon id you want to give the bot | *'''weapon:''' the weapon id you want to give the bot | ||
=Credits= | |||
*'''Slothman:''' Bot creator, main scripter | *'''Slothman:''' Bot creator, main scripter | ||
*'''Gamesnert:''' EDF creator, scripting, testing | *'''Gamesnert:''' EDF creator, scripting, testing | ||
Revision as of 15:07, 4 April 2010
This is a resource designed to allow scripts or gamemodes to insert a ped into the game that roughly simulates combat with a real player. gamemodes can implement the bots as opponents to actual players or as teammates.
Features
Teamplay: The bot is capable of identifying friend from foe
Map Navigation: When the bot is placed in a map that has suitable pathways marked out (see below on how to do that) the bot will navigate the map, seeking out enemies. Without pathways, a bot can still think for itself, but wont move around as profficiently.
Aggressiveness: Bots will attack any ped, player or bot thats not on it's team.
Cooperation: Bots can automatically team up with teammates (either player or bot) by meeting up with them and sticking together
Advanced movement: If theres obstacles blocking a bot's path, the bot will attempt to get around or over it instead of just walking into a wall for eternity
Multiple modes of playing:
- "hunting" - travel pathways untill finding an enemy or teammate
- "waiting" - stand still untill an enemy of teammate comes into view
- "guarding" - the bot will attack any enemy that comes within sight, but not move from its spawn position
- "following" - the bot will follow a player or bot while attacking enemies
- "chasing" - the bot will attack an anemy bot or player
Gamemode/Script integration: This script provides several functions and events to allow other resources to see and control what the bot's are doing, and even take control of certain behaviour.
EDF for map path creation: Integrated into the map editor, map designers can easily place paths for bots to follow along in their maps. this greatly increased the bots ability to simulate true playing.
Server Events
onBotFindEnemy
This triggers when a bot locates an enemy, This event can be cancelled to prevent the bot from chasing players
Parameters
element enemy
- enemy: The Player or Ped the bot has spotted
Source
The source of this event is the Bot that has found an enemy
onBotWasted
This triggers when a bot is killed.
Parameters
element attacker, float weapon, float bodypart
- attacker: The Element that killed the bot
- weapon: The weapon id used to kill the bot
- bodypart: The bodypart id that was hit to kill the bot
Source
The source of this event is the Bot that died
onBotSpawned
This triggers when a bot is spawned.
Source The source of this event is the Bot that spawned
onBotFollow
This triggers when a bot starts following a teammate
Parameters
element leader
- leader: The Player or Ped the bot has started following
Source
The source of this event is the Bot that starts following a teammate
Server Functions
All of these funtions will have to be used through the call function, otherwise they won't work
spawnBot
This function spawns a bot ingame
Syntax
bool spawnBot ( element theBot, float x, float y, float z, [ int rotation = 0, int skinID = 0, int interior = 0, int dimension = 0, team theTeam = nil, int weapon = nil, string theMode = "hunting", string theModesubject = nil ] )
Required Arguments
- x: The x co-ordinate to spawn the bot at
- y: The y co-ordinate to spawn the bot at
- z: The z co-ordinate to spawn the bot at
Optional Arguments
- rotation: rotation of the bot on spawn
- skinID: bots skin on spawn
- interior: interior the bot will spawn into
- dimension: The ID of the dimension that the bot should be in
- theTeam: the team the bot will join
- theMode: the action the bot will be performing when spawned (see "modes of playing" above)
- theModeSubject: if theMode is "chasing" or "hunting" this arg is needed to tell the bot what opponent to chase or teammate to follow
setBotHunt
makes the bot travel pathways untill finding an enemy or teammate Syntax
bool setBotHunt ( element theBot )
Required Arguments
- theBot: The bot you want to hunt
setBotWait
makes the bot stand still untill an enemy of teammate comes into view
Syntax
bool setBotWait ( element theBot )
Required Arguments
- theBot: The bot you want to wait
setBotChase
makes the bot attack an anemy bot or player
Syntax
bool setBotChase ( element theBot, element theTarget )
Required Arguments
- theBot: The bot that you want to do the chasing
- theTarget: The bot or player you want to be chased
setBotFollow
makes the bot follow a teammate bot or player
Syntax
bool setBotFollow( element theBot, element theTarget )
Required Arguments
- theBot: The bot that you want to do the following
- theTarget: The bot or player you want to be followed
setBotGuard
makes the bot move to the specific coords and stay there while attacking any enemies
Syntax
bool setBotGuard( element theBot, float x, float y, float z, [ bool priority = false ] )
Required Arguments
- theBot: The bot you want to do the guarding
- x: The X coords you want the bot to guard
- y: The Y coords you want the bot to guard
- z: The Z coords you want the bot to guard
Optional Arguments
- priority: Set to true only if you want the bot to only shoot once it has reached the location to guard
getBotTeam
returns the Team the bot is on, false if no team
Syntax
string getBotTeam ( element theBot)
Required Arguments
- theBot: The bot you want to check the team of
setBotTeam
changes the bot's team and loyalties
Syntax
bool setBotTeam ( element theBot, team theTeam )
Required Arguments
- theBot: The bot you want to change the team of
- theTeam: The team the bot should join
getBotAttackEnabled
returns true if the bot is allowed to attack, false otherwise
Syntax
bool getBotAttackEnabled( element theBot)
Required Arguments
- theBot: The bot you want to check if it can atack
setBotAttackEnabled
allow or disallow the bot to attack (press fire)
Syntax
bool setBotAttackEnabled( element theBot, bool enabled)
Required Arguments
- theBot: The bot you want to set if it can atack
- enabled: set to false to remove the bots ability to attack, true to allow it
getBotMode
returns the mode the bot is in ("chasing", "waiting", "guarding", "hunting", "following") or if the bot is chasing or following, it will return the mode and the target
Syntax
string getBotMode( element theBot)
Required Arguments
- theBot: The bot you want to check the status of
isPedBot
returns true if the ped is a bot, false otherwise
Syntax
bool ispedbot( element thePed)
Required Arguments
- thePed: The ped you want to check if its a bot
setBotWeapon
allow or disallow the bot to attack (press fire)
Syntax
bool setBotWeapon( element theBot, float weapon)
Required Arguments
- theBot: The bot you want to set the weapon of
- weapon: the weapon id you want to give the bot
Credits
- Slothman: Bot creator, main scripter
- Gamesnert: EDF creator, scripting, testing
- Dragon: Gamemode creator, testing, scripting help
- EvGeniz: early testing, mapping
Thanks to Everyone else who made suggestions, tested the script, helped when i was stuck, etc