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 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=shadow | 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=shadow | 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 [[Infoportions | infoportion]]
 +
|-
 +
| '''infovalue''' ''infoportion'' ''operator''
 +
| Infoportion value comparison (false is always returned is there is no such infoportion).
 +
|-
 +
| colspan=2 class=shadow | [[Gametime]] checks
 +
|-
 +
| '''fullmoon'''
 +
| Moon is on full state (note that moon can be on full state at day).
 +
|-
 +
| '''newmoon'''
 +
| Moon is on null state.
 +
|-
 +
| '''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).
 +
|-
 +
| colspan=2 class=shadow | Other checks
 +
|-
 +
| '''raining'''
 +
| Check if it is raining or snow.
 +
|}
  
−
'''false'''
 
−
:Always no
 
  
−
'''self'''.''field''
+
=== GamemodelHitPattern ===
−
: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.
+
−
 
+
−
'''player'''
+
−
:Script activator is player.
+
−
 
+
−
'''monster'''
+
−
:Script activator is [[Radiant/Glossary | NPC]].
+
−
 
+
−
'''posessed'''
+
−
:Script activator is  [[Radiant/Glossary | NPC]] posessed by player.
+
−
 
+
−
'''info''' ''infoportion''
+
−
:Activator has this [[Infoportions | infoportion]]
+
−
 
+
−
'''infovalue''' ''infoportion'' ''operator''
+
−
:Infoportion value comparison (false is always returned is there is no such infoportion).
+
−
 
+
−
'''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).
+
−
 
+
−
'''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'''
 
'''true'''
Line 183: Line 198:
 
:Always no
 
:Always no
  
−
'''pushonly'''
+
{{hidden begin | GamemodelHitPattern functions}}
−
:System word. Allows to push object but not destroy. This should be the first operator in expression if used.
+
{| width=800 border=1 cellspacing=0 cellpadding=5 style="border-collapse: collapse"
−
 
+
! width=25% | Operator
−
'''tag_''tagname'''''
+
! width=75% | Check for
−
:Returns true if model tag closest to hit position matches this tag. Otherwise 0.
+
|-
−
 
+
| '''true'''
−
'''''number''%'''
+
| Always yes
−
:Randomly returns true with this chance percentage. Typical values are 25%, 50%, 90% etc.
+
|-
−
 
+
| '''false'''
−
'''''damagetype'''''
+
| Always no
−
:Weapon that was used to hit model have this damage type. Damagetype should be one of following constants:
+
|-
−
:* '''slash''' - sword
+
| '''pushonly'''
−
:* '''crush''' - mace
+
| System word. Allows to push object but not destroy. This should be the first operator in expression if used.
−
:* '''crushblow''' - mace special hit
+
|-
−
:* '''hack''' - axe
+
| '''tag_''tagname'''''
−
:* '''impale''' - throwing knifes, arrows
+
| Returns true if model tag closest to hit position matches this tag. Otherwise 0.
−
:* '''teeth''' - animals
+
|-
−
:* '''claw''' - animals, wolf form
+
| '''''number''%'''
−
:* '''water''' - water damage
+
| Randomly returns true with this chance percentage. Typical values are 25%, 50%, 90% etc.
−
:* '''energy''' - energy bolts, magic missiles
+
|-
−
:* '''spikes''' - spike zones
+
| '''''damagetype'''''
−
:* '''flame''' - fire, flame sword
+
| Weapon that was used to hit model have this damage type. Damagetype should be one of following constants:
−
:* '''flaying''' - flay artefact
+
* '''slash''' - sword
−
:* '''imploding''' - implode artefact
+
* '''crush''' - mace
−
:* '''soulreaver''' - soul reaver magic attack
+
* '''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
 +
|}
 +
{{hidden end}}
  
−
==See also==
+
== See also ==
 
* [[Trigger event]]
 
* [[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