Editing Pattern script

Jump to: navigation, search

Warning: You are not logged in.

Your IP address will be recorded in this page's edit history.
The edit can be undone. Please check the comparison below to verify that this is what you want to do, and then save the changes below to finish undoing the edit.
Latest revision Your text
Line 1: Line 1:
−
{{TOCRIGHT}}
+
{{article unfinished}}
−
==Introduction==
+
−
Pattern scripts is special kind of expressions that returns 1 or 0. Script can check and combine wide range of conditions (gametime, special parms of entities, [[Infoportions | infoportions]] etc.). Pattern script are used for enemy appearance, gamemodel damage masks, trigger touchability and other events which only need to control availability of some action.
+
  
−
===Script input===
+
== Introduction ==
 +
Pattern scripts is special kind of expressions that returns 1 or 0. Script can check and combine wide range of conditions (gametime, special parms of entities, [[Infoportions | infoportions]] etc.). Patters script are used for enemy appearance, gamemodel damage masks, trigger touchability and other events which only need to control availability of some action.
 +
 
 +
=== Script input ===
 
* Pattern - script string
 
* Pattern - script string
−
* Script owner - entity that owns script
+
* Script owner - entity that owns pattern comparison
 
* Script activator - entity that launched comparison event
 
* Script activator - entity that launched comparison event
  
−
===Script rules===
+
=== Script rules ===
 
* Instructions are case sensative
 
* Instructions are case sensative
−
* Operators (excluding ''('' and '')'') should be separated with space or tab.
+
* Operators (excluding ''()'') should be separated by space or tab.
 
* Null script always returns 1
 
* Null script always returns 1
  
Line 24: Line 25:
 
   (night & fullmoon) | raining
 
   (night & fullmoon) | raining
  
−
==Operators==
+
== Operators ==
 
{| width=800 border=1 cellspacing=0 cellpadding=5 style="border-collapse: collapse"
 
{| width=800 border=1 cellspacing=0 cellpadding=5 style="border-collapse: collapse"
 
! width=10% | Operator
 
! width=10% | Operator
Line 30: Line 31:
 
! width=70% | Description
 
! width=70% | Description
 
|-
 
|-
−
| colspan=3 class=shadow | Logical operators (only applicable between expressions)
+
| colspan=3 class=th | '''Logical operators (only applicable between expressions)'''
 
|-
 
|-
 
| align=center | '''( )'''
 
| align=center | '''( )'''
Line 48: Line 49:
 
| Logical Not.
 
| Logical Not.
 
|-
 
|-
−
| colspan=3 class=shadow | Comparison operators
+
| colspan=3 class=th | '''Comparison operators'''
 
|-
 
|-
 
| align=center | '''='''
 
| align=center | '''='''
Line 91: Line 92:
 
|}
 
|}
  
−
==Functions==
+
== Functions ==
  
 
Set of functions is determined by pattern implementation. There is two pattern implementations as of yet.
 
Set of functions is determined by pattern implementation. There is two pattern implementations as of yet.
  
−
===GenericPattern===
+
=== GenericPattern ===
  
 
This is generic appearance pattern. It used on enemies appearance, [[Zones | zone appearance]].
 
This is generic appearance pattern. It used on enemies appearance, [[Zones | zone appearance]].
  
−
'''true'''
+
{| width=800 border=1 cellspacing=0 cellpadding=5 style="border-collapse: collapse"
−
:Always yes
+
! width=25% | Operator
 +
! width=75% | Check for
 +
|-
 +
| true
 +
| Always yes
 +
|-
 +
| false
 +
| Always no
 +
|-
 +
| colspan=2 class=th | Entity checks
 +
|-
 +
| self.''field''
 +
| Checks one of the field of script owner. Fields could be:
 +
* found - entity exists.
 +
* touchable - entity is touchable trigger or zone.
 +
* fired - trigger is deactivated. This is only applicable to: trigger_once, trigger_redirect, trigger_multi.
 +
* solved - puzzle trigger is solved. This is only applicable to: trigger_puzzle.
 +
* killed - entity was killed (deadflag is set).
 +
* dist ''x'' ''operator'' - check distance to activator.
 +
* deadtime ''x'' ''operator'' - check time enemy being dead.
 +
|-
 +
| '''enemy'''.''field''
 +
| Check field of script owner enemy. See fields list above.
 +
|-
 +
| '''target<'''''name'''''>'''.''field''
 +
| Find entity by targetname (return first match). See fields list above.
 +
|-
 +
| '''enemy<'''''radius'''''>'''.''field''
 +
| Find enemy of script owner within given radius. See fields list above.
 +
|-
 +
| '''sid<'''''name'''''>'''.''field''
 +
| Find entity by [[SaveId]]. See fields list above.
 +
|-
 +
| colspan=2 class=th | '''Activator checks'''
 +
|-
 +
| '''player'''
 +
| Script activator is player.
 +
|-
 +
| '''monster'''
 +
| Is [[Radiant Glossary | NPC]].
 +
|-
 +
| '''posessed'''
 +
| Is [[Radiant Glossary | NPC]] posessed by player.
 +
|-
 +
| '''info''' ''infoportion''
 +
| Activator has this infoportion
 +
|-
 +
| '''infovalue''' ''infoportion'' ''operator''
 +
| Infoportion value comparison (false is always returned is there is no such infoportion).
 +
|-
 +
| colspan=2 class=th | '''[[Gametime]] checks'''
 +
|-
 +
| '''fullmoon'''
 +
| Moon is on full state (note that moon can be on full state at day).
 +
|-
 +
| '''newmoon'''
 +
| Moon is on null state.
 +
|-
 +
| '''raining'''
 +
| Check if it is raining or snow.
 +
|-
 +
| '''morning'''
 +
| [[Gametime]] hour is within 5.00 - 9.59.
 +
|-
 +
| '''day'''
 +
| Gametime hour is within 10.00 - 18.59.
 +
|-
 +
| '''evening'''
 +
| Gametime hour is within 19.00 - 22.59.
 +
|-
 +
| '''night'''
 +
| Gametime hour is within 23.00 - 4.59.
 +
|-
 +
| '''hour''' x ''operator''
 +
| Gametime hour is within some bounds.
 +
|-
 +
| '''time''' x ''operator''
 +
| Gametime check using string gametime representation. All operators are supported.
 +
|-
 +
| '''daytime''' x ''operator''
 +
| Gametime check using float gametime representation (daytime).
 +
|-
 +
| '''moontime''' x ''operator''
 +
| Gametime check using float gametime representation (moontime).
 +
|}
  
−
'''false'''
+
=== GamemodelHitPattern ===
−
:Always no
+
  
−
'''self'''.''field''
+
Used on [[misc_gamemodel]] when model is hit.
−
:Checks one of the field of script owner. Fields could be:
+
−
:* '''found''' - entity exists
+
−
:* '''touchable''' - entity is touchable trigger or zone
+
−
:* '''fired''' - trigger is deactivated. This is only applicable to: trigger_once, trigger_redirect, trigger_multi
+
−
:* '''solved''' - puzzle trigger is solved. This is only applicable to: trigger_puzzle
+
−
:* '''killed''' - entity was killed (deadflag is set)
+
−
:* '''dist''' ''x'' ''operator'' - check distance to activator
+
−
:* '''deadtime''' ''x'' ''operator'' - check time enemy being dead
+
  
−
'''enemy'''.''field''
+
{{hidden begin | GamemodelHitPattern functions}}
−
:Check field of script owner enemy. See fields list above.
+
{| width=800 border=1 cellspacing=0 cellpadding=5 style="border-collapse: collapse"
−
 
+
! width=25% | Operator
−
'''target<'''''name'''''>'''.''field''
+
! width=75% | Check for
−
:Find entity by targetname (return first match). See fields list above.
+
|-
−
 
+
| '''true'''
−
'''enemy<'''''radius'''''>'''.''field''
+
| Always yes
−
:Find enemy of script owner within given radius. See fields list above.
+
|-
−
 
+
| '''false'''
−
'''sid<'''''name'''''>'''.''field''
+
| Always no
−
:Find entity by [[SaveId]]. See fields list above.
+
|-
−
 
+
| '''pushonly'''
−
'''player'''
+
| System word. Allows to push object but not destroy. This should be the first operator in expression if used.
−
:Script activator is player.
+
|-
−
 
+
| '''tag_''tagname'''''
−
'''monster'''
+
| Returns true if model tag closest to hit position matches this tag. Otherwise 0.
−
:Script activator is [[Radiant/Glossary | NPC]].
+
|-
−
 
+
| '''''number''%'''
−
'''posessed'''
+
| Randomly returns true with this chance percentage. Typical values are 25%, 50%, 90% etc.
−
:Script activator is  [[Radiant/Glossary | NPC]] posessed by player.
+
|-
−
 
+
| '''''damagetype'''''
−
'''info''' ''infoportion''
+
| Weapon that was used to hit model have this damage type. Damagetype should be one of following constants:
−
:Activator has this [[Infoportions | infoportion]]
+
* slash - sword
−
 
+
* crush - mace
−
'''infovalue''' ''infoportion'' ''operator''
+
* crushblow - mace special hit
−
:Infoportion value comparison (false is always returned is there is no such infoportion).
+
* hack - axe
−
 
+
* impale - throwing knifes, arrows
−
'''morning'''
+
* teeth - animals
−
:[[Gametime]] hour is within 5.00 - 9.59.
+
* claw - animals, wolf form
−
 
+
* water - water damage
−
'''day'''
+
* energy - energy bolts, magic missiles
−
:Gametime hour is within 10.00 - 18.59.
+
* spikes - spike zones
−
 
+
* flame - fire, flame sword
−
'''evening'''
+
* flaying - flay artefact
−
:Gametime hour is within 19.00 - 22.59.
+
* imploding - implode artefact
−
 
+
* soulreaver - soul reaver magic attack
−
'''night'''
+
|}
−
:Gametime hour is within 23.00 - 4.59.
+
{{hidden end}}
−
 
+
−
'''hour''' x ''operator''
+
−
:Gametime hour is within some bounds.
+
−
 
+
−
'''time''' x ''operator''
+
−
:Gametime check using string gametime representation. All operators are supported.
+
−
 
+
−
'''daytime''' x ''operator''
+
−
:Gametime check using float gametime representation (daytime).
+
−
 
+
−
'''moontime''' x ''operator''
+
−
:Gametime check using float gametime representation (moontime).
+
−
 
+
−
'''fullmoon'''
+
−
:Moon is on full state (note that moon can be on full state at day).
+
−
 
+
−
'''newmoon'''
+
−
:Moon is on null state.
+
−
 
+
−
'''raining'''
+
−
:Check if it is raining or snow.
+
−
 
+
−
===GamemodelHitPattern===
+
−
 
+
−
'''true'''
+
−
:Always yes
+
−
 
+
−
'''false'''
+
−
:Always no
+
−
 
+
−
'''pushonly'''
+
−
:System word. Allows to push object but not destroy. This should be the first operator in expression if used.
+
−
 
+
−
'''tag_''tagname'''''
+
−
:Returns true if model tag closest to hit position matches this tag. Otherwise 0.
+
−
 
+
−
'''''number''%'''
+
−
:Randomly returns true with this chance percentage. Typical values are 25%, 50%, 90% etc.
+
−
 
+
−
'''''damagetype'''''
+
−
:Weapon that was used to hit model have this damage type. Damagetype should be one of following constants:
+
−
:* '''slash''' - sword
+
−
:* '''crush''' - mace
+
−
:* '''crushblow''' - mace special hit
+
−
:* '''hack''' - axe
+
−
:* '''impale''' - throwing knifes, arrows
+
−
:* '''teeth''' - animals
+
−
:* '''claw''' - animals, wolf form
+
−
:* '''water''' - water damage
+
−
:* '''energy''' - energy bolts, magic missiles
+
−
:* '''spikes''' - spike zones
+
−
:* '''flame''' - fire, flame sword
+
−
:* '''flaying''' - flay artefact
+
−
:* '''imploding''' - implode artefact
+
−
:* '''soulreaver''' - soul reaver magic attack
+
−
 
+
−
==See also==
+
−
* [[Trigger event]]
+

Please note that all contributions to Blood Wiki are considered to be released under the Creative Commons Attribution Share Alike (see BloodWiki:Copyrights for details). If you do not want your writing to be edited mercilessly and redistributed at will, then do not submit it here.
You are also promising us that you wrote this yourself, or copied it from a public domain or similar free resource. Do not submit copyrighted work without permission!

Cancel | Editing help (opens in new window)

Template used on this page:

Retrieved from "http://omnicide.razorwind.ru/wiki/index.php/Pattern_script"
Personal tools
Namespaces

Variants
Actions
Navigation
Toolbox